MkDocs

MkDocs to generator dokumentacji, który przekształca pliki Markdown w kompletne statyczne strony HTML. Piszesz swoją treść w Markdown, który jest prostym formatem tekstowym, którego każdy może nauczyć się w kilka minut. MkDocs następnie przetwarza te pliki i tworzy pełną stronę internetową z nawigacją, wyszukiwaniem i atrakcyjnym designem.

Narzędzie zawiera wbudowany serwer deweloperski, który pokazuje podgląd na żywo podczas pisania. Oznacza to, że zmiany widzisz natychmiast, bez konieczności ręcznego odświeżania przeglądarki. MkDocs oferuje dwa wbudowane motywy i obsługuje wiele motywów tworzonych przez społeczność, takich jak popularny Material for MkDocs.

Ponieważ MkDocs tworzy statyczne pliki, Twoja dokumentacja ładuje się szybko i może być hostowana wszędzie, bez potrzeby skomplikowanych konfiguracji serwera czy baz danych.

Rozpoczęcie pracy z MkDocs jest proste:

• Zainstaluj Pythona na swoim komputerze, jeśli jeszcze go nie masz. MkDocs wymaga Pythona w wersji 3.8 lub nowszej, aby działać poprawnie.

• Zainstaluj MkDocs za pomocą polecenia: pip install mkdocs. To pobierze i skonfiguruje wszystko, czego potrzebujesz.

• Utwórz nowy projekt, uruchamiając: mkdocs new my-project. To stworzy folder z podstawową strukturą, w tym plik konfiguracyjny i przykładową dokumentację.

• Twórz swoją dokumentację w plikach Markdown wewnątrz folderu docs. Każdy plik stanie się stroną na Twojej stronie internetowej.

• Podglądaj swoją pracę, uruchamiając: mkdocs serve. To uruchomi lokalny serwer, zwykle pod adresem http://127.0.0.1:8000, gdzie możesz na bieżąco przeglądać swoją dokumentację.

• Zbuduj finalną wersję strony za pomocą: mkdocs build. To stworzy folder site ze wszystkimi plikami HTML gotowymi do publikacji.

• Wdróż swoją dokumentację na GitHub Pages lub dowolny serwis hostingowy, używając mkdocs gh-deploy dla GitHub lub przesyłając zawartość folderu site.

• Tworzenie dokumentacji opartej na Markdown

• Podgląd na żywo z automatycznym odświeżaniem przeglądarki

• Wbudowane i zewnętrzne wsparcie motywów

• Pojedynczy plik konfiguracyjny YAML

• System wtyczek dla rozszerzonej funkcjonalności

• Generuje szybkie statyczne strony HTML

• Zintegrowana wyszukiwarka bez usług zewnętrznych

• Możliwość wdrożenia wszędzie (GitHub Pages, Netlify itp.)

• Oprogramowanie open source i całkowicie darmowe

• Aktywne wsparcie społeczności i rozwój