{"repo":"nix-community/nixdoc","free":true,"listed":false,"github":"https://github.com/nix-community/nixdoc","clone":"git clone https://github.com/nix-community/nixdoc.git","description":"Tool to generate documentation for Nix library functions [maintainer=@hsjobeki]","language":"Rust","stars":172,"topics":["nix","rust","commonmark","documentation","markdown"],"license":"GPL-3.0","category":"docs-static-sites","readme_excerpt":"nixdoc This tool is used to generate reference documentation for Nix library functions defined in Nixpkgs' lib . Check out this example of documentation generated for the lib/strings.nix file. It uses rnix to parse Nix source files, which are then transformed into a CommonMark (with some syntax extensions) representation of the function set. Comment format This tool implements a subset of the doc-comment standard specified in RFC-145/doc-comments. But, it is currently limited to generating documentation for statically analysable attribute paths only. In the future, it could be the role of a Nix interpreter to obtain the values to be documented and their doc-comments. It is important to start doc-comments with the additional asterisk ( ) - / which renders as a doc-comment. The content of the doc-comment should conform to the Commonmark specification. Example The following is an example of markdown documentation for new and current users of nixdoc. Sidenote: Indentation is automatically detected and should be consistent across the content. If you are used to multiline-strings ( '' ) in nix this should be intuitive to follow. nix add 4 5 = 9 add :: Number - Number - Number Note: Within nixpkgs the convention of using definition-lists for documenting arguments has been established. Usage Refer to nixdoc --help for the most up-to-date usage information. For a minimal format, suitable for inclusion into a dedicated documentation page, use: Export mode ( --manifest ) Export mode tak","default_branch":null,"files":null,"tree":[],"storefront":"/r/nix-community","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/nix-community/nixdoc/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."}