{"id":13472231,"url":"https://github.com/rtomayko/ronn","last_synced_at":"2025-05-14T06:14:21.135Z","repository":{"id":711818,"uuid":"358599","full_name":"rtomayko/ronn","owner":"rtomayko","description":"the opposite of roff","archived":false,"fork":false,"pushed_at":"2022-01-29T05:32:21.000Z","size":535,"stargazers_count":1368,"open_issues_count":50,"forks_count":84,"subscribers_count":28,"default_branch":"master","last_synced_at":"2025-04-02T22:36:53.472Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://rtomayko.github.com/ronn/","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rtomayko.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES","contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2009-11-02T22:11:27.000Z","updated_at":"2025-03-27T11:10:26.000Z","dependencies_parsed_at":"2022-07-18T05:21:33.376Z","dependency_job_id":null,"html_url":"https://github.com/rtomayko/ronn","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rtomayko%2Fronn","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rtomayko%2Fronn/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rtomayko%2Fronn/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rtomayko%2Fronn/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rtomayko","download_url":"https://codeload.github.com/rtomayko/ronn/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248324911,"owners_count":21084823,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-31T16:00:53.143Z","updated_at":"2025-04-11T01:30:11.328Z","avatar_url":"https://github.com/rtomayko.png","language":"Ruby","funding_links":[],"categories":["Ruby","Documentation","others","Documentation [🔝](#readme)","文档","2015年2月1日（日）"],"sub_categories":["Runner","运行器","运行器e2e测试"],"readme":"# Ronn\n\nRonn builds manuals. It converts simple, human readable textfiles to roff for\nterminal display, and also to HTML for the web.\n\nThe source format includes all of Markdown but has a more rigid structure and\nsyntax extensions for features commonly found in manpages (definition lists,\nlink notation, etc.). The ronn-format(7) manual page defines the format in\ndetail.\n\nThe `*.ronn` files found in the [`man/`][1] directory show off a wide range of\nronn capabilities:\n\n  * [ronn(1)](http://rtomayko.github.com/ronn/ronn.1) command -\n    [source file](http://github.com/rtomayko/ronn/blob/master/man/ronn.1.ronn),\n    [roff output](http://github.com/rtomayko/ronn/blob/master/man/ronn.1)\n\n  * [ronn-format(7)](http://rtomayko.github.com/ronn/ronn-format.7) -\n    [source file](http://github.com/rtomayko/ronn/blob/master/man/ronn-format.7.ronn),\n    [roff output](http://github.com/rtomayko/ronn/blob/master/man/ronn-format.7)\n\n[1]: http://github.com/rtomayko/ronn/tree/master/man\n\nAs an alternative, you might want to check out [pandoc](http://johnmacfarlane.net/pandoc/) which can also convert markdown into roff manual pages.\n\n## Examples\n\nBuild roff and HTML output files for one or more input files:\n\n    $ ronn man/ronn.5.ronn\n    roff: man/ronn.5\n    html: man/ronn.5.html\n\nGenerate only a standalone HTML version of one or more files:\n\n    $ ronn --html man/markdown.5.ronn\n    html: man/markdown.5.html\n\nBuild roff versions of all ronn files in a directory:\n\n    $ ronn --roff man/*.ronn\n\nView a ronn file as if it were a manpage without building intermediate files:\n\n    $ ronn --man man/markdown.5.ronn\n\nView roff output with man(1):\n\n    $ man man/ronn.5\n\nThe [ronn(1)](http://rtomayko.github.com/ronn/ronn.1) manual page includes\ncomprehensive documentation on `ronn` command line options.\n\n## Background\n\nSome think UNIX manual pages are a poor and outdated form of documentation. I\ndisagree:\n\n- Manpages follow a well defined structure that's immediately familiar. This\n  gives developers a starting point when documenting new tools, libraries, and\n  formats.\n\n- Manpages get to the point. Because they're written in an inverted style, with\n  a SYNOPSIS section followed by additional detail, prose and references to\n  other sources of information, manpages provide the best of both cheat sheet\n  and reference style documentation.\n\n- Historically, manpages use an extremely -- unbelievably -- limited set of\n  text formatting capabilities. You get a couple of headings, lists, bold,\n  underline and no more. This is a feature.\n\n- Although two levels of section hierarchy are technically supported, most\n  manpages use only a single level. Unwieldy document hierarchies complicate\n  otherwise good documentation. Remember that Feynman covered all of physics\n  -- heavenly bodies through QED -- with only two levels of document hierarchy\n  (_The Feynman Lectures on Physics_, 1970).\n\n- The classical terminal manpage display is typographically well thought out.\n  Big bold section headings, justified monospace text, nicely indented\n  paragraphs, intelligently aligned definition lists, and an informational\n  header and footer.\n\n- Manpages have a simple referencing syntax; e.g., sh(1), fork(2), markdown(7).\n  HTML versions can use this to generate links between pages.\n\nUnfortunately, figuring out how to create a manpage is a fairly tedious process.\nThe roff/mandoc/mdoc macro languages are highly extensible, fractured between\nmultiple dialects, and include a bunch of device specific stuff irrelevant to\nmodern publishing tools.\n\n## Copying\n\nRonn is Copyright (C) 2010 [Ryan Tomayko](http://tomayko.com/about)\u003cbr\u003e\nSee the file COPYING for information of licensing and distribution.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frtomayko%2Fronn","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frtomayko%2Fronn","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frtomayko%2Fronn/lists"}