{"id":13897543,"url":"https://github.com/apjanke/ronn-ng","last_synced_at":"2025-04-15T03:50:24.194Z","repository":{"id":52296999,"uuid":"162836190","full_name":"apjanke/ronn-ng","owner":"apjanke","description":"Ronn-NG: An updated fork of ronn. Build man pages from Markdown.","archived":false,"fork":false,"pushed_at":"2025-03-12T03:29:42.000Z","size":603,"stargazers_count":85,"open_issues_count":29,"forks_count":17,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-15T03:50:00.911Z","etag":null,"topics":["documentation","manpages"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apjanke.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-12-22T19:04:38.000Z","updated_at":"2025-03-12T03:29:40.000Z","dependencies_parsed_at":"2024-06-18T21:22:09.030Z","dependency_job_id":"cd5b71d2-8714-4f68-87cb-d45857f81491","html_url":"https://github.com/apjanke/ronn-ng","commit_stats":{"total_commits":514,"total_committers":21,"mean_commits":"24.476190476190474","dds":0.5097276264591439,"last_synced_commit":"0f42377f9c9102946f8d3980b5bec40c3fafde24"},"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apjanke%2Fronn-ng","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apjanke%2Fronn-ng/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apjanke%2Fronn-ng/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apjanke%2Fronn-ng/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apjanke","download_url":"https://codeload.github.com/apjanke/ronn-ng/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249003944,"owners_count":21196794,"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":["documentation","manpages"],"created_at":"2024-08-06T18:03:40.681Z","updated_at":"2025-04-15T03:50:24.166Z","avatar_url":"https://github.com/apjanke.png","language":"Ruby","funding_links":[],"categories":["Ruby"],"sub_categories":[],"readme":"# Ronn-NG\n\nRonn-NG is a new, currently-maintained fork of the defunct [original Ronn\nproject](https://github.com/rtomayko/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) man 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)](https://rtomayko.github.io/ronn/ronn.1.html) command –\n  [source file](https://github.com/apjanke/ronn-ng/blob/main/man/ronn.1.ronn),\n  [roff output](https://github.com/apjanke/ronn-ng/blob/main/man/ronn.1)\n\n* [ronn-format(7)](https://rtomayko.github.io/ronn/ronn-format.7.html) file format –\n  [source file](https://github.com/apjanke/ronn-ng/blob/main/man/ronn-format.7.ronn),\n  [roff output](https://github.com/apjanke/ronn-ng/blob/main/man/ronn-format.7)\n\n[1]: https://github.com/apjanke/ronn-ng/tree/main/man\n\nAs an alternative, you might want to check out [pandoc](https://pandoc.org/) which can also convert markdown into roff manual pages.\n\n## Installation\n\nInstall with Homebrew on macOS:\n\n```bash\nbrew tap apjanke/ronn-ng\nbrew install ronn-ng\n```\n\nInstall with `gem` anywhere that supports it:\n\n```bash\ngem install ronn-ng\n```\n\nSee [INSTALLING.md](INSTALLING.md) for details on other systems and installation methods.\n\n## Examples\n\nBuild roff and HTML output files for one or more input files:\n\n```bash\n$ ronn man/ronn.5.ronn\nroff: man/ronn.5\nhtml: man/ronn.5.html\n```\n\nGenerate only a standalone HTML version of one or more files:\n\n```bash\n$ ronn --html man/markdown.5.ronn\nhtml: man/markdown.5.html\n```\n\nBuild roff versions of all ronn files in a directory:\n\n```bash\n$ ronn --roff man/*.ronn\n```\n\nView a ronn file as if it were a manpage without building intermediate files:\n\n```bash\n$ ronn --man man/markdown.5.ronn\n```\n\nView roff output with man(1):\n\n```bash\n$ man man/ronn.5\n```\n\nThe [ronn(1)](https://rtomayko.github.io/ronn/ronn.1.html) man page includes\ncomprehensive documentation on `ronn` command line options.\n\n## Background\n\nSome think Unix man pages are a poor and outdated form of documentation. Ronn-NG\ndisagrees:\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. Ronn aims to solve that problem.\n\n## Requirements\n\nRonn-NG requires Ruby 2.4 or newer.\n\nIf you are installing Ronn-NG as a standalone program (the usual way to use it), it\nincludes all its Ruby libraries, and has no other dependencies. If you are using\nRonn-NG as a gem or other library, it requires gems as listed in `ronn-ng.gemspec`.\n\n## Project Management\n\nThe project home page is at \u003chttps://github.com/apjanke/ronn-ng\u003e. Bug reports,\nfeature requests, and patch submissions are welcome.\n\nRonn-NG was forked from the original Ronn project in 2018 after Ronn\ndevelopment had been defunct for a couple years, and Andrew wanted\nsome bugs fixed.\n\n## License and Copying\n\nMIT License.\n\nRonn is Copyright (C) 2010 [Ryan Tomayko](https://github.com/rtomayko).\n\nNew Ronn-NG material is Copyright (C) 2018-2022 [Andrew Janke](https://apjanke.net) and other contributors.\n\nSee the file LICENSE.txt for information of licensing and distribution.\n\n## Build Status\n\n![Travis build status](https://travis-ci.com/apjanke/ronn-ng.svg?branch=main)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapjanke%2Fronn-ng","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapjanke%2Fronn-ng","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapjanke%2Fronn-ng/lists"}