redtape

redtape является целенаправленный документ генератор, который использует GitHub приправленный уценки генерировать простые, привлекательные HTML документов. Он автоматически интегрируется с Twitter Bootstrap и отличается простым и привлекательным стилем. redtape вдохновлен D, но попытки имеют простой интерфейс, все еще позволяя пользователям стиль и контролировать свои выходные документы в высокой степени настройки.
Установка
Если вы находитесь на Linux или OSX, вы можете использовать Пип установить:
> PIP установить redtape
Какой будет установить redtape и его зависимостей.
Использование
Для использования, выполнения RT на документе или каталога полном документов. Если работать на каталог, RT будет создавать HTML-файлы для каждого файла (уценки .md, .mdown или .markdown расширения):
> RT mydocument.md
> RT документация /
активы
По умолчанию, RT предполагает, что вы создали место, чтобы служить файлы из которых имеют активы, которые RT ссылки в этих документах. Макет точно так же, как в каталоге активов в репозитории redtape: / активы / {CSS, IMG, JS} / .. для каждого актива, который вы будете использовать. Если вы хотите использовать активы redtape по умолчанию, вы можете легко создать подходящую директорию активов в текущем каталоге, запустив:
> RT --create-активы
Если вы работаете в в однопользовательском режиме документа или не хотите, чтобы настроить каталог активов на конечную хостом для ваших HTML документов, вы можете сказать, redtape вставлять каждый актив, используемый в документе, используя --embed:
> RT --embed mydocument.md
Javascript
По умолчанию, redtape не требует JavaScript для запуска, и не будет вставлять любое --embed в режиме. Если выбран вариант --prettify, приукрасить библиотека Google будет использовать для выделения источник вместо pygments, и если --prettify и --embed оба используются, он будет автоматически вкладывается.
Redtape также подходит для простых одной страницы яваскрипта демонстраций, и если --use-JS включен, redtape будет включать в себя JQuery и JavaScript библиотеки Bootstrap в.
настройки выхода
Настройка вывода легко сделать в различными способами. Кроме того, изменения CSS активов для не-встроенный документов, вы также можете добавить верхние и нижние колонтитулы или даже использовать пользовательские шаблоны документов, основанных на шаблоне redtape по умолчанию.
заголовки и колонтитулы
Если у вас есть настроенный заголовок документа или сноски, вы хотите добавлен в документах, вы можете либо добавить header.html и footer.html документы в корневой каталог вы рендеринга или установленных путей по умолчанию, которые будут использоваться в конфигурации как верхний и нижний колонтитулы. По умолчанию, они будут размещены в верхней и нижней части документа, соответственно.
Примерный набор документов могут быть:
> Ls MyDocs /
MyDocs / index.md MyDocs / simple.md MyDocs / advanced.md
MyDocs / header.html MyDocs / footer.html
Оказание MyDocs с RT MyDocs будет использовать верхний и нижний колонтитулы для каждого документа в каталоге.
пользовательские шаблоны
Если у вас есть особые требования, вы можете написать свой собственный шаблон документа и полный контроль на выходе. Redtape использует шаблонизатор jinja2, который широко используется система шаблонов похож на Django шаблоны. Запустите redtape с --context аргумента, чтобы получить краткое представление о том, что переменные доступны в шаблоне.
Вы также можете наследовать от basic.jinja, что имя шаблона redtape по умолчанию. Этот шаблон определяет два блока, голову и тело, которые позволили бы вам выработать четкую документ тела время, например, сохраняя основную функциональность CSS и JavaScript в redtape. Переопределение и оставит вас со стандартным HTML5 структуры документа.
Вы можете указать пользовательский шаблон для использования с -t, --template или поместить его в каталог документа как custom.html или custom.jinja

Требования :.

• Python