Markdoc спрямована до управління технічної документації, але може бути використаний для різних цілей. Markdoc має кілька помітних точок продажів:
* Вікі складені повністю з текстових файлах, так що ви можете легко покласти їх під управління версіями.
* Вікі компіляції в автономні HTML каталогів, які можуть бути розподілені в тарбол або обслуговуються HTTP-сервер.
* Ви можете додатково включати статичні засоби масової інформації, які будуть скомпільовані в HTML каталог разом всіх надаваних сторінок.
* Markdoc поставляється з повністю функціональною чисто Python WSGI додатків і HTTP-сервер для обслуговування до скомпільовані вікі.
* Ви можете зробити вашу вікі з різними розширеннями Markdown, таких як Pygments основі підсвітку коду, розширеного синтаксису для списків визначень, покоління TOC, і так далі.
* Ви можете повністю налаштувати, як ваша вікі надають редагування шаблонів jinja2, використовувані для перетворення винесене Markdown повною HTML документів.
<Сильний> Швидкий старт
Установка:
#! / Bin / Bash
рт клон SSH: //hg@bitbucket.org/zacharyvoase/markdoc
CD markdoc /
пункт встановити -r ВИМОГИ
пітон setup.py встановити
Створення Wiki
#! / Bin / Bash
markdoc инициализировать мій-вікі
CD-моєму вікі /
Вім вікі / somefile.md
# ... Написати деяку документацію ...
markdoc збірки
markdoc служити
# .. Відкрита HTTP: // локальний: 8008 / в браузері ...
<Сильний> Макет
Markdoc вікі мають наступну структуру за замовчуванням:
WIKI_ROOT /
| - .html /
| - .templates /
| - .tmp /
| - Статичний /
| - Вікі /
`- Markdoc.yaml
.html / І TMP- / каталоги повинні бути виключені з будь-яких VCS, так як вони містять тимчасові файли.
Зверніться до документації макета в DOC / вікі / layout.md для отримання додаткової інформації про роль різних підкаталогах
Вимоги :.
- Python
- піп
- Rsync
Коментар не знайдено