Referência rápida

Folha de Dicas de Criação de Manuais Ronn

Guia de referência rápida para Ronn: conversão de documentos Markdown em páginas de manual roff padrão do UNIX e documentação HTML.

· Publicado

Ronn cria páginas man a partir de texto Markdown, gerando arquivos de formato roff UNIX padrão e documentação HTML independente.

Estrutura básica de um documento man (tool.1.ronn)

tool(1) -- descrição concisa da ferramenta
======================================

## SYNOPSIS

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

## DESCRIPTION

**tool** processa arquivos e imprime resultados na saída padrão.

## OPTIONS

  * `-v`, `--verbose`:
    Ativar saída detalhada de log.

  * `-o` <file>, `--output`=<file>:
    Especificar arquivo de saída de destino.

  * `-h`, `--help`:
    Exibir tela de ajuda.

## EXAMPLES

Executar a ferramenta em todos os arquivos markdown:

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

## SEE ALSO

man(1), ronn(7)

Comandos de compilação (Compilation Commands)

# Converter para página man UNIX roff padrão (tool.1)
ronn --roff tool.1.ronn

# Converter para o formato HTML (tool.1.html)
ronn --html tool.1.ronn

# Visualizar diretamente no terminal sem gravar arquivo
ronn --man tool.1.ronn

Referências

Temas relacionados