Szybka pomoc

Ściągawka z tworzenia dokumentacji Ronn

Skrócony przewodnik po Ronn: konwersja dokumentów Markdown do standardowych stron podręcznika UNIX roff i dokumentacji HTML.

· Opublikowano

Ronn buduje strony man z tekstu Markdown, generując standardowe pliki UNIX roff oraz samodzielną dokumentację HTML.

Podstawowa struktura dokumentu Man (tool.1.ronn)

tool(1) -- zwięzły opis narzędzia
======================================

## SYNOPSIS

`tool` [<options>] <files>...

## DESCRIPTION

**tool** przetwarza pliki i wypisuje wyniki na standardowe wyjście.

## OPTIONS

  * `-v`, `--verbose`:
    Włącz szczegółowe rejestrowanie (verbose).

  * `-o` <file>, `--output`=<file>:
    Określ docelowy plik wyjściowy.

  * `-h`, `--help`:
    Wyświetl ekran pomocy.

## EXAMPLES

Uruchom narzędzie dla wszystkich plików markdown:

    $ tool -v *.md -o output.log

## SEE ALSO

man(1), ronn(7)

Polecenia kompilacji (Compilation Commands)

# Konwertuj do standardowej strony man UNIX roff (tool.1)
ronn --roff tool.1.ronn

# Konwertuj do formatu HTML (tool.1.html)
ronn --html tool.1.ronn

# Wyświetl bezpośrednio w terminalu bez zapisywania pliku
ronn --man tool.1.ronn

Źródła

Powiązane tematy