diff --git a/README.md b/README.md index cfe1987..80eebc4 100644 --- a/README.md +++ b/README.md @@ -873,6 +873,24 @@ jobs: uses: GeoNet/Actions/.github/workflows/reusable-presubmit-readme-toc.yml@main ``` +**important** to note: a markdown file must contain the following + +```text + + + +``` + +given a markdown file (e.g: `README.md`) and the contents above included +in the markdown file, the table of contents can be generated with the command +in that comment: + +```shell +go run sigs.k8s.io/mdtoc@latest --inplace README.md +``` + +note: requires Go to be installed + ### Presubmit GitHub Actions workflow validator STATUS: stable