2013-03-14 6 views
14

С помощью Sphinx-doc вы можете создать кучу файлов ReStructureText с файлом index.rst, который включает в себя макрос оглавления, который автоматически генерирует оглавление из других включенных файлов, и conf.py, который выступает в качестве конфигурации компиляции. Затем вы можете скомпилировать лот в один сайт в стиле python-doc, в комплекте с индексом, навигационными инструментами и функцией поиска.Весь компилятор сайта markdown/pandoc?

Есть ли сравнимый инструмент для уценки (желательно уценка типа pandoc)?

+1

Есть ли также инструмент для документирования (markdown), который может создавать PDF и ePub так же просто, как Sphinx? –

+0

@white_gecko Редактировать в [Markdown] (http://daringfireball.net/projects/markdown/syntax#overview), конвертировать в XHTML с помощью [pandoc] (http://johnmacfarlane.net/pandoc/README.html) и, наконец, конвертировать в PDF с помощью [PrinceXML] (http://www.princexml.com/), который вы можете использовать или не использовать бесплатно (см. [CSO license] (http://www.princexml.com/license/)) , Опять же, просмотрите [мой сайт] (http://hamwaves.com/cl-ocfd/en/index.html) для деталей. Существует альтернатива с открытым исходным кодом, называемая [wkhtmltopdf] (http://wkhtmltopdf.org/), которая, однако, не хороша при нарушении страницы. –

ответ

9

Некоторые статические генераторы сайтов, которые работают с Markdown:

Я думаю, что ни один из них не использует pandoc (возможно, потому, что он написан в Haskell), но все они используют расширенный синтаксис Markdown или могут быть настроены на использование pandoc.

Другие интересные способы создания сайта из уценки:

  • Markdown- Wikis, которые файл на основе: f.ex. Gollum, Wiki-Engine, который также используется GitHub
  • Telegram: commercial; написанный Дэвидом Поллака, изобретатель Подъемник-Scala-рамочном

Двигатели, использующие Pandoc:

Окончательный список Генераторы Статическая сайта

Хороший обзор статических генераторов сайта: http://staticsitegenerators.net/

+0

Hyde - это в основном CMS, не так ли? Мне не нужно что-то, что я должен покинуть. Некоторые из других выглядят интересными, хотя, спасибо за список! – naught101

+1

Насколько я знаю, Hyde производит также статический HTML, как Jekyll. – Sonson123

+1

Для тех, кто идет за мной: Пеликан классный, но он нацелен на блог, а не на статичный сайт, как сфинкс. – naught101

7

Pandoc, ГНУ make и sed команды, посыпают некоторым CSS все, что вам нужно полностью автоматизировать создание статического веб-сайта, начиная с Markdown.

Pandoc предлагает три опции командной строки, которые могут обеспечивать навигацию между страницами, а также создание оглавления (TOC) на основе заголовков внутри страницы. С помощью CSS вы можете сделать навигацию и TOC выглядеть и вести себя так, как вы хотите.

-B FILE, --include-до того тела = FILE

Включить содержимое файла, стенографические, в начале тела документа (например, после тега в HTML, или \ {начать document} в LaTeX). Это можно использовать для включения навигационных панелей или баннеров в HTML-документы. Этот параметр можно использовать повторно для включения нескольких файлов. Они будут включены в указанный заказ. Подразумевает --стандарт.

--toc, --table-из-содержимого

Включить автоматически сгенерированного оглавление.

--toc глубина = ЧИСЛО

Укажите количество уровней раздела, чтобы включить в таблицу содержимого. Значение по умолчанию равно 3 (это означает, что заголовки уровня 1, 2 и 3 будут указаны в содержимом).

По сути, my personal website is built this way. За более подробной информацией обратитесь к его makefile. Это бесплатная лицензия с открытым исходным кодом под лицензией GNU GPL version 3.

+1

Er ... эти опции TOC относятся к заголовкам * внутри * файла уценки. Я говорю о TOC для нескольких файлов, каждая отдельная страница. Ваш личный сайт - это одна страница ... – naught101

+0

@ naught101 Я отредактировал свой ответ. Навигация между страницами может быть легко обработан опцией '--include-before-body = FILE'. –

+0

Нет, вам не хватает смысла.Sphinx-doc позволяет вам писать несколько страниц * в виде отдельных файлов *, а затем создает HTML-файл для каждой страницы (с TOC в боковой панели), а также полностраничный html-файл TOC (который не имеет .rst, но он автоматически генерируется). Это то, о чем я прошу. – naught101

1

Если вы не используете Pandoc, mkdocs, похоже, соответствует вашим потребностям.

Если вы определенно хотите использовать Markdown с ароматом Pandoc, вы можете проверить pdsite. Я написал это как способ генерации сайта в стиле mkdocs с большим количеством входных форматов (например, org-mode emacs) и без зависимостей Python - вы проходите в папку файлов Markdown и выходите на сайт HTML (включая автоматически генерируемые мультиплееры -уровневые навигационные ссылки). Это похоже на подход Сергея Стробандта в том смысле, что это всего лишь сценарий оболочки (он требует, чтобы вы установили tree). К сожалению, у него еще нет функции поиска, хотя это было бы не слишком сложно добавить ...