fundoc
mdBook
fundoc | mdBook | |
---|---|---|
4 | 101 | |
163 | 16,754 | |
0.0% | 2.0% | |
5.1 | 8.6 | |
about 1 year ago | 7 days ago | |
Rust | Rust | |
MIT License | Mozilla Public License 2.0 |
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.
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
mdBook
- Everything Curl
- Doks – Build a Docs Site
-
Ask HN: How do you organize software documentation at work?
I'm responsible for a number of Java products. I try to provide high-quality Javadoc for all public library interfaces, library user's guides where appropriate, and development guides for applications. The latter two take the form of MDBook documents (https://rust-lang.github.io/mdBook/), with the document source living in the GitHub repo so that it's tied to the particular software release in a natural way.
-
Outline: Self hostable, realtime, Markdown compatible knowledge base
My org has used mdBook: https://rust-lang.github.io/mdBook/ (That link is itself a rendered mdBook, so that'll give you an idea of the feature set.)
(While it's definitely a Rust "thing", if you just have a set of .md files, all you need is a "SUMMARY.md" (which contains the ToC) and a small config file; i.e., you don't have to have any Rust code to use it, and it works fine without. We document a large, mostly non-Rust codebase with it.)
-
Ask HN: Best tools for self-authoring books in 2023?
If you want the lowest friction, open source, easily extensible Markdown to Web, Kindle, PDF, etc. tool, highly recommend mdBook: https://github.com/rust-lang/mdBook it’s written in Rust, but you don’t have to know any Rust to use it. And then wing is all CSS; for which there are many good (free) themes.
- Early performance results from the prototype CHERI ARM Morello microarchitecture
- FLaNK Stack for 4th of July
- MdBook – A command line tool to create books with Markdown
- MdBook Create book from Markdown files. Like Gitbook but implemented in Rust
What are some alternatives?
doctave - A batteries-included developer documentation site generator
gitbook - The open source frontend for GitBook doc sites
linters - CSSSR's linting configs for Prettier and ESLint.
MkDocs - Project documentation with Markdown.
repository
Wiki.js - Wiki.js | A modern and powerful wiki app built on Node.js
mkdocs-material - Documentation that simply works
bookdown - Authoring Books and Technical Documents with R Markdown
github-orgmode-tests - This is a test project where you can explore how github interprets Org-mode files
obsidian-releases - Community plugins list, theme list, and releases of Obsidian.
Docusaurus - Easy to maintain open source documentation websites.
rubigo