redtape

redtape jest skupiony generator dokument, który wykorzystuje GitHub aromatyzowanej przecen do generowania prostych, atrakcyjnych dokumentów HTML. To automatycznie integruje się z twitter bootstrap i oferuje prosty i atrakcyjny stylizacji. redtape jest inspirowane przez d, ale stara się mieć prosty interfejs, a jednocześnie pozwala użytkownikom projektować i kontroli dokumentów wyjściowych do wysokiego stopnia dostosowania.
instalacji
Jeśli jesteś na Linuksie lub OSX, można użyć pip zainstalować:
> Pip install redtape
Która zainstaluje redtape i jego zależności.
Zastosowanie
Aby go wykorzystać, run rt na dokumencie lub katalogu pełnej dokumentacji. Jeśli zostanie uruchomione na katalogu, rt, będzie tworzyć pliki html dla każdego pliku wyprzedaży (.md NumerKopiiZapasowej, .mdown lub .markdown rozszerzenia):
> Rt mydocument.md
> Dokumentacja rt /
wartości
Domyślnie rt zakłada skonfigurowaniu lokalizacji służyć pliki, z których mają majątku, że RT linki do tych dokumentów. Układ jest dokładnie taki sam jak w katalogu aktywów w repozytorium redtape: / aktywa / {css, img, js} / .. dla każdego składnika aktywów, która będzie używana. Jeśli chcesz korzystać z zasobów domyślnych redtape, można łatwo stworzyć odpowiedni katalog aktywów w bieżącym katalogu, uruchamiając:
> rt --create-aktywa
Jeśli działa w trybie pojedynczego dokumentu lub nie chcą założyć katalog aktywów na ewentualnego gospodarza dokumentów HTML, można powiedzieć redtape osadzić każdy składnik aktywów wykorzystywany w dokumencie za pomocą --embed:
> Rt --embed mydocument.md
javascript
Domyślnie redtape nie wymaga JavaScript, aby działać i nie będzie osadzać się w trybie --embed każda. Jeśli wybrana jest opcja --prettify, upiększać biblioteki Google będzie używany przez źródło podkreślając zamiast pygments, a jeśli --prettify i --embed są zarówno używane, to zostanie on automatycznie osadzone.
Redtape nadaje się również do prostych pojedynczej strony javascript demonstracji, a jeśli --use-js jest włączona, redtape obejmie jQuery i biblioteki javascript Bootstrap jest.
wyjście dostosowywania
Dostosowywanie wyjścia jest łatwe do zrobienia w różny sposób. Poza zmianą CSS aktywów na dokumenty spoza osadzone, można także dodać nagłówki i stopki, a nawet używać własnych szablonów dokumentów opartych na domyślnym szablonie redtape za.
nagłówki i stopki
Jeśli masz niestandardowy nagłówek dokumentu lub stopkę chcesz dodawać do dokumentów, można dodać header.html i footer.html dokumentów z katalogu podstawowego jesteś renderowania lub ustalonych ścieżek standardowych powinny być stosowane w konfiguracji jako nagłówka i stopki. Domyślnie będą one umieszczone na górze i na dole dokumentu, odpowiednio.
Zestaw próbek dokumentów może być:
> ls mydocs /
mydocs / index.md mydocs / simple.md mydocs / advanced.md
mydocs / header.html mydocs / footer.html
Rendering z rt mydocs folderu Moje będzie korzystać z nagłówka i stopki dla każdego dokumentu w katalogu.
niestandardowe szablony
Jeśli masz bardzo specyficzne wymagania, można napisać własny szablon dokumentu i mają całkowitą kontrolę wyjścia. Redtape korzysta z silnika szablonów jinja2, który jest powszechnie stosowany System szablonów Django szablony podobny do. Uruchom redtape z --context argumentu, aby informacja, o tym, co zmienne są dostępne w szablonie.
Możesz również dziedziczyć basic.jinja, który jest nazwa szablonu domyślnego redtape za. Ten szablon definiuje dwa bloki, głowę i ciało, które pozwalają, by stworzyć odrębną chwilę ciała dokument, na przykład, zachowując podstawowe funkcje CSS i JavaScript w redtape. Zastępowanie zarówno zostawię cię z normą struktury dokumentu HTML5.
Możesz określić własnego szablonu, aby korzystać z -t, --template lub umieścić go w katalogu dokumentów jako custom.html lub custom.jinja

Wymagania .

• Python