Referencia rápida

Chuleta de redacción de manuales con Ronn

Guía de referencia rápida para Ronn: conversión de documentos Markdown en páginas man roff estándar y documentación HTML.

· Publicado

Ronn genera páginas man a partir de texto Markdown, produciendo archivos en formato UNIX roff estándar y documentación HTML independiente.

Estructura básica de un documento man (tool.1.ronn)

tool(1) -- descripción concisa de la herramienta
======================================

## SYNOPSIS

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

## DESCRIPTION

**tool** procesa archivos e imprime los resultados en la salida estándar.

## OPTIONS

  * `-v`, `--verbose`:
    Habilitar salida detallada (verbose).

  * `-o` <file>, `--output`=<file>:
    Especificar el archivo de destino de salida.

  * `-h`, `--help`:
    Mostrar pantalla de ayuda.

## EXAMPLES

Ejecutar la herramienta sobre todos los archivos markdown:

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

## SEE ALSO

man(1), ronn(7)

Comandos de compilación (Compilation Commands)

# Convertir a página man UNIX roff estándar (tool.1)
ronn --roff tool.1.ronn

# Convertir a formato HTML (tool.1.html)
ronn --html tool.1.ronn

# Ver directamente en terminal sin escribir un archivo
ronn --man tool.1.ronn

Referencias

Temas relacionados