This is an opinionated approach to keeping README.md a bit standarized formatter.
It uses prettier and markdown-toc.
Once installed and ddev restart
, it will start up a process watching for
changes on your README.md. If you wish to disable this you can edit and remove
#ddev-generated
from config.readme.yaml
or add
DDEV_README_WATCH_DISABLED=true
as en environment variable to your project.
For you toc generation to work automatically, you have to add the following somewhere on your README.md:
<!-- toc -->
<!-- tocstop -->
You can always install the latest code with
ddev get https://github.com/hanoii/ddev-readme/tarball/main
Contributed and maintained by @hanoii