Весь сайт сборка уценки / пандока?
С помощью Sphinx-doc вы можете создать несколько файлов ReStructureText с index.rst файл, который включает макрос оглавления, который автоматически генерирует оглавление из других включенных файлов, и conf.py это действует как конфигурация компиляции. Затем вы можете скомпилировать партию в единый сайт в стиле python-doc, в комплекте с индексом, инструментами навигации и функцией поиска.
Существует ли какой-либо сопоставимый инструмент для уценки (предпочтительно в стиле пандока)?
3 ответа
Некоторые статические генераторы сайтов, которые работают с Markdown:
- Jekyll очень популярен, а также движок за страницами GitHub.
- Варианты Python: Гайд или Пеликан
- nanoc (используется, например, в документации по GitHub API)
- http://middlemanapp.com/: может быть, лучший?
Я думаю, что ни один из них не использует pandoc (возможно, потому что он написан на Haskell), но все они используют расширенный синтаксис Markdown или могут быть настроены для использования pandoc.
Другие интересные способы создания сайта из уценки:
- Markdown - Вики, основанные на файлах: f.ex. Gollum, Wiki-движок, который также используется GitHub
- Телеграмма: коммерческая; написанный Дэвидом Поллаком, изобретателем Lift-Scala-framework
Двигатели, использующие Pandoc:
- Gitit: Pandoc Wiki
- Пандок-плагин для Икивики
- Yst статический генератор сайтов
- Гауда - генерирует сайт из каталога файлов уценки
- Rippledoc - генерирует навигационный сайт из вложенных каталогов файлов уценки
Окончательный список генераторов статических сайтов
Хороший обзор генераторов статического сайта: http://staticsitegenerators.net/
Pandoc, команды GNU make и sed, усыпанные небольшим количеством CSS, - это все, что вам нужно для полной автоматизации создания статического веб-сайта, начиная с Markdown.
Pandoc предлагает три параметра командной строки, которые могут обеспечить навигацию между страницами, а также создание оглавления (TOC) на основе заголовков внутри страницы. С помощью CSS вы можете заставить навигацию и оглавление выглядеть и вести себя так, как вы хотите.
-B ФАЙЛ, --include-before-body = ФАЙЛ
Включите содержимое FILE, дословно, в начало тела документа (например, после тега в HTML или команды \begin{document} в LaTeX). Это можно использовать для включения панелей навигации или баннеров в документы HTML. Эту опцию можно использовать несколько раз, чтобы включить несколько файлов. Они будут включены в указанном порядке. Подразумевает --standalone.
--toc, --table-of-content
Включите автоматически сгенерированное оглавление.
--toc глубина = ЧИСЛО
Укажите количество уровней раздела для включения в оглавление. По умолчанию установлено значение 3 (это означает, что заголовки уровня 1, 2 и 3 будут перечислены в содержимом).
На самом деле, мой личный сайт построен таким образом. Проверьте его make-файл для более подробной информации. Это все свободно распространяемые лицензии с открытым исходным кодом в соответствии с GNU GPL версии 3.
Если вы в порядке и не используете Pandoc, mkdocs, похоже, подойдет вам.
Если вы определенно хотите использовать Markdown со вкусом Pandoc, вы можете проверить pdsite. Я написал его как способ получить генерацию сайта в стиле mkdocs с большим количеством входных форматов (например, emacs org-mode) и без зависимостей Python - вы переходите в папку файлов Markdown и получаете сайт HTML (включая автоматически сгенерированный мульти навигационные ссылки высокого уровня). Это похоже на подход Сержа Стробандта в том, что это всего лишь сценарий оболочки (для этого нужно иметь tree установлен однако). К сожалению, у него пока нет функции поиска, хотя добавить его будет несложно...