redtape ay isang nakatuong generator dokumento na gumagamit ng github may lasa markdown upang bumuo ng simple, kaakit-akit na mga dokumento HTML. Awtomatiko itong Sumasama sa twitter Bootstrap at nagtatampok ng simple, kaakit-akit na estilo. redtape ay hango sa d, ngunit sumusubok na magkaroon ng isang simpleng interface habang pinapayagan pa rin ang mga user na estilo at kontrolin ang kanilang mga dokumento output sa isang mataas na antas ng pag-customize.
Pag-install ng
Kung ikaw ay nasa linux o OSX, maaari mong gamitin ang buto ng bungang-kahoy upang i-install:
> PIP install redtape
Na-install redtape at dependency nito.
Paggamit
Upang magamit, run RT sa isang dokumento o direktoryo na puno ng mga dokumento. Kung nagpapatakbo sa isang direktoryo, RT Lilikha html file para sa bawat markdown file (.md, .mdown, o .markdown extension):
> RT mydocument.md
> RT dokumentasyon /
asset
Sa pamamagitan ng default, ipinagpapalagay RT nag-set up ng isang lokasyon upang maghatid ng mga file mula sa kung saan ay may mga asset na RT link sa mga dokumentong ito. Layout ng ay eksaktong kapareho ng sa direktoryo asset sa redtape imbakan: / asset / css {, img, js} / .. para sa bawat asset na ginagamit mo. Kung nais mong gamitin ang default na mga asset redtape, maaari mong madaling lumikha ng angkop na direktoryo ng asset sa mga kasalukuyang direktoryo sa pamamagitan ng pagtakbo:
> RT --create-asset
Kung nagpapatakbo ka sa iisang mode na dokumento o hindi nais na mag-set up ng isang direktoryo ng asset sa sa wakas host para sa iyong mga dokumento ng HTML, maaari mong sabihin sa redtape upang i-embed ang bawat asset na ginagamit sa isang dokumento sa pamamagitan ng paggamit --embed:
> RT --embed mydocument.md
javascript
Sa pamamagitan ng default, redtape hindi nangangailangan ng anumang javascript upang tumakbo, at hindi i-embed anumang sa --embed mode. Kung ang --prettify opsyon ay napili, pagandahin library google ay magagamit para sa source ng pag-highlight sa halip ng pygments, at kung --prettify at --embed ay parehong ginagamit, ito ay awtomatikong naka-embed.
Redtape ay angkop para sa simpleng javascript demonstrations solong-pahina na rin, at kung --use-js ay gumagana, redtape ay magsasama jquery at javascript library Bootstrap iyon.
-customize ng output
Pag-customize ng output ay madaling gawin sa iba't ibang paraan. Bukod sa pagbabago ng CSS asset para sa mga hindi naka-embed na mga dokumento, maaari ka ring magdagdag ng mga header at footer o kahit na gumamit ng pasadyang mga template ng dokumento batay sa default na template redtape iyon.
mga header at footer
Kung mayroon kang isang customized header dokumento o footer gusto mo maidagdag sa iyong mga dokumento, maaari mong alinman sa magdagdag ng header.html at footer.html mga dokumento sa base ng direktoryo ikaw ay nagre-render o magtakda ng default na path na gagamitin sa config bilang ng header at footer. Sa pamamagitan ng default, ang mga ito ay ilagay sa tuktok at ibaba ng iyong mga dokumento, ayon sa pagkakabanggit.
Ang isang halimbawa ng hanay ng mga dokumento ay maaaring:
> L mydocs /
mydocs / index.md mydocs / simple.md mydocs / advanced.md
mydocs / header.html mydocs / footer.html
-Render mydocs may RT mydocs ay gamitin ang header at footer para sa bawat dokumento sa direktoryo.
pasadyang mga template
Kung mayroon kang napaka-tukoy na mga pangangailangan, maaari mong isulat ang iyong sariling mga template ng dokumento at magkaroon ng ganap na kontrol ng output. Redtape ay gumagamit ng jinja2 templating engine, na isang malawakang ginagamit templating sistema na katulad ng Django mga template. Patakbuhin redtape sa --context argumento upang makakuha ng isang maikling ideya ng kung ano variable ay magagamit mo sa template.
Maaari mo ring magmana mula basic.jinja, kung saan ay ang pangalan ng default na template redtape iyon. Tinutukoy ng template na ito ng dalawang bloke, ulo at katawan, na mag-daan sa iyo upang craft ng naiibang nilalaman ng dokumento habang, halimbawa, napananatili ang pangunahing CSS at pag-andar ng JavaScript ng redtape. Pinakamahalaga parehong mag-iiwan sa iyo ng isang standard na istraktura ng dokumento ng HTML5.
Maaari mong tukuyin ang isang pasadyang template na gagamitin sa -t, --template o ilagay ito sa direktoryo dokumento bilang custom.html o custom.jinja
Mga Kinakailangan :.
- Python
Mga Komento hindi natagpuan