redtape

redtape є цілеспрямований документ генератор, який використовує GitHub ароматний уцінки для створення простої, привабливою HTML документів. Він автоматично інтегрується з Twitter Bootstrap і відрізняється простим і привабливим стиль. redtape натхненний D, але спроби мають простий інтерфейс в той же час дозволяючи користувачам стиль і контролювати свої вихідні документи у високому ступені настройки.
Установка
Якщо ви знаходитесь на Linux або OSX, ви можете використовувати PIP, щоб встановити:
> Пункт встановити redtape
Що дозволить встановити redtape і його залежності.
Використання
Для використання, виконання РТ по документу або папці, повної документів. Якщо працювати на каталог, RT буде створювати HTML-файли для кожного уцінки файлу (.md, .mdown або .markdown розширення):
> RT mydocument.md
> RT документація /
активи
За замовчуванням, RT припускає, що ви створили місце, щоб служити файли з, які мають активи, які РТ посилання в цих документах. Макет точно так само, як в каталозі ресурсів у сховищі redtape: / активи / {CSS, IMG, JS} / .. для кожного активу, який ви будете використовувати. Якщо ви хочете використовувати активи redtape За замовчуванням, ви можете легко створити відповідну директорію активів в поточному каталозі, запустивши:
> RT --create-активи
Якщо ви працює в режимі одного документа або не хочете створити каталог активів на кінцеву хостом для ваших HTML документів, ви можете сказати redtape вставляти кожен актив використовується в документі, використовуючи --embed:
> RT --embed mydocument.md
JavaScript
За замовчуванням, redtape не вимагає яких-небудь наявність працювати, і не буде вставляти будь в --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