{"repo":"pyrmont/predoc","free":true,"listed":false,"github":"https://github.com/pyrmont/predoc","clone":"git clone https://github.com/pyrmont/predoc.git","description":"A Markdown flavour for man pages","language":"Janet","stars":12,"topics":["documentation","man-page","markdown","mdoc"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"Predoc Predoc is a Markdown flavour specifically designed for writing man pages. [!WARNING] Predoc is in a beta stage of development. There are likely to be bugs and gaps in its implementation. This is the repository for the reference implementation of the parser and renderer written in the [Janet programming language][janet-hp]. It includes a command-line utility, predoc , which converts a Predoc document into a man page written in mdoc. [janet-hp]: https://janet-lang.org You can try out Predoc in your browser on the [project homepage][ph]. [ph]: https://pyrmont.github.io/predoc/ Example Predoc allows you to take this: and convert it to this: which in turn is rendered by man into this: Language Rationale Documentation is great and man pages can be a wonderful source of information. But people are discouraged from creating or updating man pages because the syntax of mdoc and roff (the markup languages used for these documents) is intimidating. Predoc aims to remedy this. Markdown allows a person to create HTML that 'looks like' what they wrote. Predoc wants to do the same thing for man pages: create mdoc that 'looks like' what is written in plain text. Syntax Like Markdown, Predoc is a lightweight markup language that optimises for ease-of-reading and ease-of-writing. It does this by specifying its syntactic constructs using punctuation characters. More information about the Predoc language is in predoc(7) . You can (hopefully) see the benefit of writing man pages in Predoc b","default_branch":null,"files":null,"tree":[],"storefront":"/r/pyrmont","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/pyrmont/predoc/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}