A https://readme.md/ is brilliant for small projects. For very large projects, there are lot of mature tools: mdbook (used for Rust), Sphinx (used for Python) and Scribble (used for Racket).
I don't know of many good options for "slightly bigger than a README" though.
miniblog.
Related Posts
12
There are docs resources like https://diataxis.fr/ that categorise documents based on format and intended audience.
They don't say where you should start, or what order you should write docs.
I'm currently thinking README > reference > tutorial > how-tos. Agree/disagree?
Today I learnt that Lua projects often use *3* spaces for indentation! https://github.com/luarocks/lua-style-guide/blob/master/README.md#indentation-and-formatting
I initially thought something was very wrong with editor config.
I've released difftastic 0.13! In this release:
* Added support for Bash, Common Lisp and Ruby
* Improved C, CSS, JS, JSON, TS and plain text in comments
* A bunch of new explanatory screenshots in the README
