HowTo docs

brief

documentation as code approach

short description

  • organize your content in folders
  • add one or more files to a folder
  • don’t name your files README.md

long description

docs-as-code approach:

Handle your (developer) documentation like code.

  • checkout the branch gh-pages
  • add / modify content
  • push it into the repo
  • wait 1 or 2 minutes (workflows indexing and ToC, publish to pages)

Documentation As Code - Docs-as-Code

docToolchain - Create awesome docs the easy way!

arc42 - document your software architecture

:vulcan_salute:

(back to top)