From 476abc9dad5b2dab6e9109a20a73557e7f992ae9 Mon Sep 17 00:00:00 2001 From: Geoff Bourne Date: Sat, 1 May 2021 17:34:12 -0500 Subject: [PATCH] docs: Added table of contents #845 --- .github/workflows/generate-toc.yml | 20 ++++++++++++++++++++ README.md | 5 +++++ 2 files changed, 25 insertions(+) create mode 100644 .github/workflows/generate-toc.yml diff --git a/.github/workflows/generate-toc.yml b/.github/workflows/generate-toc.yml new file mode 100644 index 00000000..976746fc --- /dev/null +++ b/.github/workflows/generate-toc.yml @@ -0,0 +1,20 @@ +name: Generate README table of contents +on: + push: + branches: + - master + paths: + - README.md +jobs: + generate: + runs-on: ubuntu-latest + timeout-minutes: 5 + steps: + - uses: actions/checkout@v2 + - run: | + curl https://raw.githubusercontent.com/ekalinin/github-markdown-toc/master/gh-md-toc -o gh-md-toc + chmod a+x gh-md-toc + ./gh-md-toc --insert --no-backup README.md + - uses: stefanzweifel/git-auto-commit-action@v4 + with: + commit_message: Auto update markdown TOC \ No newline at end of file diff --git a/README.md b/README.md index 7d772c44..01b2390a 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,11 @@ With that you can easily view the logs, stop, or re-start the container: > Be sure to always include `-e EULA=TRUE` in your commands, as Mojang/Microsoft requires EULA acceptance. +**TABLE OF CONTENTS** + + + + ## Looking for a Bedrock Dedicated Server For Minecraft clients running on consoles, mobile, or native Windows, you'll need to