Markdoc

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