빠른 참조

Ronn 매뉴얼 작성 치트시트

Markdown 문서를 표준 UNIX roff man 페이지 및 HTML 문서로 변환하는 Ronn 빠른 참조 가이드.

· 게시일

Ronn은 Markdown 텍스트에서 man 페이지를 빌드하여 표준 UNIX roff 형식 파일과 독립형 HTML 문서를 생성합니다.

기본 Man 문서 구조 (tool.1.ronn)

tool(1) -- 도구에 대한 간결한 설명
======================================

## SYNOPSIS

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

## DESCRIPTION

**tool**은 파일을 처리하고 표준 출력으로 결과를 인쇄합니다.

## OPTIONS

  * `-v`, `--verbose`:
    상세 로그 출력 활성화.

  * `-o` <file>, `--output`=<file>:
    대상 출력 파일 지정.

  * `-h`, `--help`:
    도움말 화면 표시.

## EXAMPLES

모든 마크다운 파일에 대해 도구 실행:

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

## SEE ALSO

man(1), ronn(7)

컴파일 명령어 (Compilation Commands)

# 표준 UNIX roff man 페이지로 변환 (tool.1)
ronn --roff tool.1.ronn

# HTML 형식으로 변환 (tool.1.html)
ronn --html tool.1.ronn

# 파일을 생성하지 않고 터미널에서 직접 보기
ronn --man tool.1.ronn

참고 자료

관련 주제