log4brains
doctave
Our great sponsors
log4brains | doctave | |
---|---|---|
6 | 13 | |
1,055 | 521 | |
- | 1.5% | |
0.0 | 0.0 | |
3 months ago | over 1 year ago | |
TypeScript | Rust | |
Apache License 2.0 | 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.
log4brains
-
A practical overview on Architecture Decision Records (ADR)
There is an interesting win-win tool called log4brains, that can turn your markdown into a static website. It's also integrated into MADR template. I haven’t had time to try them yet, but it's in my backlog.
-
Can't bring myself to produce code any more, any ideas to help?
I'm a solution architect in my current job, and I love it because I still get to solve technical problems and help/mentor more junior developers but I don't really write code anymore (except on minor occasions and it's mostly by choice). The tradeoff is I have to write docs and make presentations, but I learned how to do that easily enough.
- Build some good documentation habits in your team with ADRs (Architecture Decision Records) and their go-to tool: Log4brains
- Document your project by logging your decisions chronologically with ADRs (Architecture Decision Records)
- Log4brains: Document your projects by logging your decisions chronologically with ADRs (Architecture Decision Records)
- Document your projects by logging your architecture decisions chronologically with ADRs (Architecture Decision Records)
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.
What are some alternatives?
adr-tools - Command-line tools for working with Architecture Decision Records
elasticlunr.js - Based on lunr.js, but more flexible and customized.
vscode-front-matter - Front Matter is a CMS running straight in Visual Studio Code. Can be used with static site generators like Hugo, Jekyll, Hexo, NextJs, Gatsby, and many more...
docuowl - 🦉 A documentation generator
documentalist - :memo: A sort-of-static site generator optimized for living documentation of software projects
Docusaurus - Easy to maintain open source documentation websites.
mdSilo-app - Lightweight Knowledge Base and Feed Reader.
Elixir - Elixir is a dynamic, functional language for building scalable and maintainable applications
mm-docs-template - Template to use with mm-docs
earmark - Markdown parser for Elixir
prpl - Lightweight library for building fast static sites
MkDocs - Project documentation with Markdown.