{"id":13570461,"url":"https://github.com/pyrmont/documentarian","last_synced_at":"2025-04-13T12:24:07.172Z","repository":{"id":47704183,"uuid":"262643664","full_name":"pyrmont/documentarian","owner":"pyrmont","description":"A document generation tool for Janet projects","archived":false,"fork":false,"pushed_at":"2024-12-14T21:40:41.000Z","size":136,"stargazers_count":20,"open_issues_count":0,"forks_count":2,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-07T03:30:38.707Z","etag":null,"topics":["documentation","janet","markdown"],"latest_commit_sha":null,"homepage":"","language":"Janet","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/pyrmont.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-05-09T19:26:46.000Z","updated_at":"2024-12-16T02:06:34.000Z","dependencies_parsed_at":"2024-12-14T22:23:17.642Z","dependency_job_id":"7fa1daac-236f-47c6-bb5b-1a18c1de53df","html_url":"https://github.com/pyrmont/documentarian","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyrmont%2Fdocumentarian","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyrmont%2Fdocumentarian/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyrmont%2Fdocumentarian/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyrmont%2Fdocumentarian/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pyrmont","download_url":"https://codeload.github.com/pyrmont/documentarian/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242864302,"owners_count":20197689,"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","janet","markdown"],"created_at":"2024-08-01T14:00:52.578Z","updated_at":"2025-03-10T13:53:06.782Z","avatar_url":"https://github.com/pyrmont.png","language":"Janet","funding_links":[],"categories":["Janet"],"sub_categories":[],"readme":"# Documentarian\n\n[![Build Status][icon]][status]\n\n[icon]: https://github.com/pyrmont/documentarian/workflows/build/badge.svg\n[status]: https://github.com/pyrmont/documentarian/actions?query=workflow%3Abuild\n\nDocumentarian is a minimal documentation generation tool for Janet projects.\n\nDocumentarian makes it easy to take the docstrings you've already written for\nyour code and turn them into a simple Markdown-formatted document. This document\ncan be included in your repository and read easily on services like GitHub.\n\n## Installation\n\nTo install, run:\n\n```shell\n$ jpm install https://github.com/pyrmont/documentarian\n```\n\n## Usage\n\n```shell\n$ /path/to/documentarian\n```\n\nDocumentarian depends on your project having a `project.janet` file that\ncontains a `:name` key in the `declare-project` form and a `:source` key in\neither the `declare-source` or `declare-native` forms. The `:source` key can be\nassociated with individual files or a directory containing Janet files.\n\nSince the API document is generated in Markdown, you can include Markdown in\nyour docstrings. Don't forget that Janet supports `` ` ``-delimited\n[long strings][ls] in addition to regular `\"`-delimited strings. Long strings\npreserve whitespace (including newlines) which can be used to create lists,\nheadings and code blocks.\n\n[ls]: https://janet-lang.org/docs/strings.html\n\nBy default, your documentation is saved to a file called `api.md` in the\ncurrent working directory. Documentarian includes a simple template that is\nused to produce the `api.md` file. You can specify your own template file using\nthe `-t` command-line argument (see below). The file must be in the [Mustache\ntemplating language][mustache]. Documentarian processes the template using\n[Musty][]. Please note that Musty is an incomplete implementation and does not\nsupport the more advanced features of Mustache.\n\n[mustache]: http://mustache.github.io\n[Musty]: https://github.com/pyrmont/musty\n\n### Command-Line Arguments\n\nDocumentarian supports the following command-line arguments:\n\n```\n -d, --defix \u003cprefix\u003e       Remove \u003cprefix\u003e from all namespaces.\n -L, --link-prefix \u003curl\u003e    Use \u003curl\u003e as prefix for source code links.\n\n -O, --only \u003cpath\u003e          Only create entries for bindings in \u003cpath\u003e in the API document.\n -x, --exclude \u003cpath\u003e       Exclude bindings in \u003cpath\u003e from the API document.\n -P, --private              Include private values in the API document.\n\n -p, --project \u003cpath\u003e       Use \u003cpath\u003e as project file. (Default: project.janet)\n -l, --local                Set Janet's modpath to ./jpm_tree.\n -t, --tree \u003cpath\u003e          Set Janet's modpath to \u003cpath\u003e.\n\n -e, --echo                 Output to stdout rather than output file.\n -o, --out \u003cpath\u003e           Use \u003cpath\u003e as filename for the API document. (Default: api.md)\n -T, --template \u003cpath\u003e      Use \u003cpath\u003e as template for the API document.\n\n -h, --help                 Show this help message.\n```\n\n## Bugs\n\nFound a bug? I'd love to know about it. The best way is to report your bug in\nthe [Issues][] section on GitHub.\n\n[Issues]: https://github.com/pyrmont/documentarian/issues\n\n## Licence\n\nDocumentarian is licensed under the MIT Licence. See [LICENSE][] for more\ndetails.\n\n[LICENSE]: https://github.com/pyrmont/documentarian/blob/master/LICENSE\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpyrmont%2Fdocumentarian","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpyrmont%2Fdocumentarian","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpyrmont%2Fdocumentarian/lists"}