Wprowadzenie

Simple Docs zamienia uporządkowane pliki Markdown w statyczną witrynę dokumentacji z nawigacją i wyszukiwarką. Pliki źródłowe pozostają podstawą wszystkich zmian, a generator tworzy z nich strony HTML.

Zakres polskiego przykładu#

To częściowy przykład polskiej dokumentacji: zawiera wprowadzenie i instrukcję instalacji. Pełny podręcznik jest dostępny po wybraniu języka English w przełączniku języka. Domyślnym językiem witryny jest angielski pod /en/, a polski przykład znajduje się pod /pl/.

Przełącznik otwiera odpowiadającą stronę w wybranym języku. Jeśli tłumaczenie nie istnieje, prowadzi do spisu treści tego języka.

Układ dokumentacji#

Katalogi tworzą sekcje, a pliki tworzą strony. Dwucyfrowe prefiksy określają kolejność czytania, ale nie pojawiają się w adresach stron. Tłumaczenia zachowują te same identyfikatory sekcji i stron w nazwach plików; tytuły i treść mogą być zapisane po polsku, z użyciem znaków diakrytycznych.

• Poświęć każdą stronę jednemu zadaniu lub pojęciu.
• Używaj krótkich sekcji i opisowych nagłówków.
• Odsyłaj do istniejących stron zamiast powtarzać instrukcje.

Przejdź do instrukcji instalacji.

Wyszukiwanie#

Wyszukiwarka obejmuje tylko bieżący język. Wyniki prowadzą do pasujących stron i nagłówków oraz pokazują fragmenty treści. Możesz podać kilka słów w dowolnej kolejności albo początki słów, na przykład instal.

Naciśnij /, aby przejść do wyszukiwarki. Strzałkami wybierz wynik, klawiszem Enter otwórz stronę, a klawiszem Escape zamknij wyniki.

Czytanie bez sieci#

Wersja offline działa po rozpakowaniu archiwum ZIP. Otwórz manual-site-offline/index.html i wybierz język. Nawigacja i wyszukiwanie nie wymagają serwera ani połączenia z internetem.