Generuj dokumentację za pomocą plików Markdown przy użyciu Docsify

Jeśli tworzysz darmową wtyczkę, framework lub skrypt open-source potrzebujesz dokumentacji. To bardzo ważne udokumentuj swoją pracę, zarówno dla twojego zdrowia psychicznego, jak i dla innych, którzy chcą nauczyć się niesamowitych zasobów.

Jednak tworzenie dokumentacji online może być prawdziwym bólem. Na szczęście, Docsify ułatwia to, udostępniając darmowy generator dokumentacji działający na Markdown.

To jest nie typowy statyczny generator witryn i tak jest nie wymaga statycznych stron HTML / CSS. Zamiast tego ładuje pliki Markdown dynamicznie i wyświetla je jako strony internetowe. Całkiem schludnie!

Sprawdź stronę główną Docsify a podgląd układu, wraz z dalsze szczegóły konfiguracji.

To wymaga ciebie utwórz sam plik index.html, które można następnie przesłać na strony GitHub lub hostować na własnym serwerze. Stamtąd po prostu pisz pliki Markdown dla każdej strony i używaj ich jako swoich głównych doktorów.

Cały proces jest szczegółowo opisany w skrócona instrukcja obsługi, więc to chyba najlepsze miejsce do rozpoczęcia. To może wszystko biegnie przez npm, więc naprawdę pomaga znać swój wiersz poleceń lub przynajmniej być gotowym do nauki.

Możliwe jest samodzielne utworzenie surowego pliku HTML i skopiowanie / wklejenie szablonu z przewodnika instalacji Docsify. Ale polecam robić to dynamicznie, ponieważ oszczędza mnóstwo czasu - i czyż nie tak naprawdę jest?

W miarę poznawania systemu Docsify możesz dodaj funkcje za pomocą Markdown lub surowego HTML. Funkcje te obejmują niestandardowy pasek nawigacyjny i nawet własną stronę tytułową z logo twojego projektu.

Docsify nawet jest dostarczany z mnóstwem darmowych motywów jeśli chcesz, aby gotowe szablony działały. Albo możesz przeglądaj ich galerię wizytówek aby zobaczyć, które projekty używają Docsify do swojej dokumentacji.

Wszystkie podstawowe informacje dotyczące konfiguracji i pobierania plików można znaleźć na GitHub, więc udaj się tam, jeśli chcesz dać temu szansę.

Możesz również zobacz demonstrację na żywo na głównej stronie dokumentacji Docsify co, oczywiście, działa na Docsify. Więc jeśli podoba Ci się ten układ strony, możesz użyć tego samego szablonu i uruchomić go w Docsify, w 100% za darmo i open-source.