search

sindresorhus / awesome-nodejs

:zap: Delightful Node.js packages and resources
https://node.cool
Creative Commons Zero v1.0 Universal
57.83k stars 5.81k forks source link

Add Log4brains to Documentation tools #1095

Closed thomvaill closed 3 years ago

thomvaill commented 3 years ago

By submitting this pull request, I promise I have read the contribution guidelines twice and ensured my submission follows it. I realize not doing so wastes the maintainers' time that they could have spent making the world better. 🖖

⬆⬆⬆⬆⬆⬆⬆⬆⬆⬆

Log4brains - https://github.com/thomvaill/log4brains Example of a generated knowledge base: https://thomvaill.github.io/log4brains/adr/

Log4brains is a docs-as-code knowledge base for your development and infrastructure projects. It enables you to log Architecture Decision Records (ADR) right from your IDE and to publish them automatically as a static website. It's available as a NPM package that should be installed globally:

npm install -g log4brains

# Then, in your project's root folder, run:
log4brains init

# And then you can use:
log4brains adr new
log4brains preview
log4brains build
sindresorhus commented 3 years ago

Thanks for the suggestion. This looks like a nice, but I think it's a bit too niche for this list. The list tries to include things most devs will need.

I would recommend submitting it to https://github.com/simskij/awesome-software-architecture instead.