doctave
fundoc
doctave | fundoc | |
---|---|---|
13 | 4 | |
521 | 163 | |
0.0% | 0.0% | |
0.0 | 5.1 | |
over 1 year ago | about 1 year ago | |
Rust | Rust | |
MIT License | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
doctave
-
After looking around for better note apps briefly, I came back with a new theme instead
(For an example of a site generated by the open source Doctave docs site generator, you can take a look at its own docs.)
-
Doctave 0.4 | Documentation site generator
Doctave Documentation (self-hosted, obviously) Broken links docs Math notation docs
- Doctave: a batteries-included docs site generator
-
Wikis don't work for software documentation
Secondly, you have to think about search. If you use a documentation site generator to turn your Markdown docs into HTML sites, even if the toolchain builds a search index for the site, you will end up with N disconnected sites for N projects. Doctave.com can help with this if you are using our open source documentation site generator.
-
Doctave CLI 0.2.0: A Benchmarking Story
Finally, do try out Doctave 0.2.0! If you're looking for a batteries-included documentation generator that doesn't require plugins, doesn't pollute your repository with loads of files, and doesn't need a specialized environment to run, Doctave may be a good choice for you. It also comes with Mermaid JS diagram support and dark mode!
-
Using Rust with Elixir for code reuse and performance
Reuse code from our open source documentation generator CLI that is built in Rust
-
Any recommendations on a good tool for documentation?
I'm not sure specifically what you're looking for but perhaps consider this: https://github.com/Doctave/doctave The main site: https://www.doctave.com/
-
Doctave: a batteries-included documentation site generator
We have a backlog of features and tweaks we are working on for Doctave. I’d love to hear your feedback, so if you give Doctave a spin, let me know what you think! You can reach out to me directly on Twitter or open an issue on GitHub.
fundoc
- Fundoc 0.5.0 has been released. It is a language-agnostic documentation generator based on mdBook with support for plugins written in Lua and cross-repository documentation generation.
- Fundoc - is a documentation generator that helps you keep your documentation up-to-date. It's also based on the idea of literate programming and allow to write documentation directly in source files
-
Problems with documentation writing
I tried finding something which could solve all of these problems, but unfortunately, I hadn't found it. So I wrote my own tool called Fundoc to achieve all described goals and even more. The tool can:
- Solving problems of writing documentation
What are some alternatives?
elasticlunr.js - Based on lunr.js, but more flexible and customized.
linters - CSSSR's linting configs for Prettier and ESLint.
docuowl - 🦉 A documentation generator
repository
Docusaurus - Easy to maintain open source documentation websites.
mkdocs-material - Documentation that simply works
Elixir - Elixir is a dynamic, functional language for building scalable and maintainable applications
github-orgmode-tests - This is a test project where you can explore how github interprets Org-mode files
earmark - Markdown parser for Elixir
MkDocs - Project documentation with Markdown.
pulldown-cmark - An efficient, reliable parser for CommonMark, a standard dialect of Markdown
benchee - Easy and extensible benchmarking in Elixir providing you with lots of statistics!