Generovat dokumentaci pomocí souborů Markdown pomocí Docsify

Pokud vytváříte bezplatný plugin, framework nebo open-source skript budete potřebovat dokumentaci. Je to zásadní dokumentujte svou práci, jak pro váš zdravý rozum, tak pro pomoc ostatním, kteří se chtějí naučit svůj úžasný zdroj.

Vytváření online dokumentace však může být skutečnou bolestí. díkybohu, Ověřit usnadňuje to poskytnutím zdarma generátor dokumentace běžící na Markdown.

Tohle je není typický generátor statických stránek a dělá nevyžadují statické stránky HTML / CSS. Místo toho načte soubory služby Markdown dynamicky a zobrazí je jako webové stránky. Docela elegantní!

Podívejte se na domovskou stránku Docsify a náhled rozložení, spolu s další podrobnosti nastavení.

Vyžaduje to, abyste vytvořte soubor index.html sami, které pak můžete nahrát na stránky GitHub nebo hostit na vlastním serveru. Odtud jen pro každou stránku zapisujte soubory Markdown a používejte je jako primární dokumenty.

Celý proces je podrobně popsán v rychlý návod, takže je to asi nejlepší místo, kde začít. To může všechny běží přes npm, tak to opravdu pomáhá znát váš příkazový řádek nebo alespoň být ochoten se učit.

Je možné vytvořit surový soubor HTML sami a kopírovat / vložit šablonu z průvodce nastavením programu Docsify. Ale doporučuji dynamicky, protože to ušetří spoustu času - a to není ten pravý bod?

Jak se naučíte systém Docsify, můžete přidávat funkce pomocí funkce Markdown nebo raw HTML. Mezi tyto funkce patří a vlastní navigační panel a dokonce vlastní titulní stránku s logem vašeho projektu.

Zjednodušte dokument je dodáván se spoustou volných témat chcete-li pracovat s předem navrženými rozvrženími. Nebo můžete procházet jejich galerií zjistit, které projekty používají dokumentaci Docsify.

Všechno základní informace o nastavení a stahování souborů lze nalézt na GitHub, takže hlavu tam, pokud chcete dát tento záběr.

Můžete také viz živé demo na hlavní stránce dokumentace Docsify což, jistě, běží na Docsify. Takže pokud se vám líbí rozložení webové stránky, můžete použít stejnou šablonu a spustit ji prostřednictvím služby Docsify, 100% zdarma a open source.