{"repo":"pyrmont/documentarian","free":true,"listed":false,"github":"https://github.com/pyrmont/documentarian","clone":"git clone https://github.com/pyrmont/documentarian.git","description":"A document generation tool for Janet projects","language":"Janet","stars":25,"topics":["janet","documentation","markdown"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"Documentarian [![Test Status][icon]][status] [icon]: https://github.com/pyrmont/documentarian/workflows/test/badge.svg [status]: https://github.com/pyrmont/documentarian/actions?query=workflow%3Atest Documentarian is a minimal documentation generation tool for Janet projects. Documentarian makes it easy to take the docstrings you've already written for your code and turn them into a simple Markdown-formatted document. This document can be included in your repository and read easily on services like GitHub. Installation To install, run: Usage Documentarian depends on your project having a project.janet file that contains a :name key in the declare-project form and a :source key in either the declare-source or declare-native forms. The :source key can be associated with individual files or a directory containing Janet files. Since the API document is generated in Markdown, you can include Markdown in your docstrings. Don't forget that Janet supports -delimited [long strings][ls] in addition to regular \" -delimited strings. Long strings preserve whitespace (including newlines) which can be used to create lists, headings and code blocks. [ls]: https://janet-lang.org/docs/strings.html By default, your documentation is saved to a file called api.md in the current working directory. Documentarian includes a simple template that is used to produce the api.md file. You can specify your own template file using the -t command-line argument (see below). The file must be in the [Mustache ","default_branch":null,"files":null,"tree":[],"storefront":"/r/pyrmont","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/pyrmont/documentarian/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."}