{"repo":"daynin/fundoc","free":true,"listed":false,"github":"https://github.com/daynin/fundoc","clone":"git clone https://github.com/daynin/fundoc.git","description":"Fundoc - the right way to generate documentation","language":"Rust","stars":166,"topics":["documentation","cli","documentation-generator","rust","literate-programming","documentation-as-code"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"Language agnostic documentation generator. Written in Rust 🦀 Fundoc - the right way to generate documentation. Business features in your project can be implemented in different files and even in different technologies. Fundoc can merge all descriptions of those features and put them in appropriate files. Fundoc's main goals: - Allow you to keep all your documentation along with your code . Separating documentation and code makes it harder to support projects. - Use the same versioning tools for your documentation and code. All versions of your documentation should match versions of source code otherwise we can't trust documentation. - Documentation generators should allow you to write your documentation from different file types like source code files (Rust, C++, TypeScript, Java, JavaScript, Ruby, Python, etc), specification files (Alloy, TLA+, etc), stylesheet files (CSS, SCSS, QT Stylesheets, etc), configs (JSON, TOML, YAML, etc). Why you should use it If you want to keep your documentation synchronized with your code and to be able to describe different parts of a business feature in places where it was implemented you can write documentation in your source files or near them. One source file, one documentation file You can describe business logic in one particular source file and generate documentation from it. It can be useful for describing config files, features implemented in one file or component, etc. Here you can find an example of using Fundoc to describe ESLint","default_branch":null,"files":null,"tree":[],"storefront":"/r/daynin","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/daynin/fundoc/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."}