miniblog.

← Back to all posts
Aug 7, 2013 at 16:44
Just discovered https://github.com/thlorenz/doctoc for adding tables of contents to README.md files. Previously I had to put important stuff first.
GitHub - thlorenz/doctoc: 📜 Generates table of contents for markdown files inside local git repository. Links are compatible with anchors generated by github or other sites.
GitHub - thlorenz/doctoc: 📜 Generates table of contents for markdown files inside local git repository. Links are compatible with anchors generated by github or other sites.
📜 Generates table of contents for markdown files inside local git repository. Links are compatible with anchors generated by github or other sites. - thlorenz/doctoc

Related Posts

Jun 2, 2025 at 22:31
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?
Diátaxis
Jun 29, 2024 at 07:20
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.
lua-style-guide/README.md at master · luarocks/lua-style-guide
lua-style-guide/README.md at master · luarocks/lua-style-guide
Lua Style Guide, as used by LuaRocks. Contribute to luarocks/lua-style-guide development by creating an account on GitHub.
Dec 5, 2021 at 08:13
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
PhotoPhoto
X / ?