Skip to content

Commit

Permalink
md-toc - update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
alxgomz committed Dec 5, 2024
1 parent 9388a52 commit 7bfe837
Showing 1 changed file with 23 additions and 23 deletions.
46 changes: 23 additions & 23 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ Here follows the list of GitHub Actions topics available in the current document
- [maven-deploy-file](#maven-deploy-file)
- [maven-release](#maven-release)
- [maven-update-pom-version](#maven-update-pom-version)
- [md-toc](#md-toc)
- [nexus-move-artifacts](#nexus-move-artifacts)
- [pre-commit](#pre-commit)
- [process-coverage-report](#process-coverage-report)
Expand All @@ -97,7 +98,6 @@ Here follows the list of GitHub Actions topics available in the current document
- [setup-terraform-docs](#setup-terraform-docs)
- [setup-updatebot](#setup-updatebot)
- [slack-file-upload](#slack-file-upload)
- [md-toc](#md-toc)
- [update-deployment-runtime-versions](#update-deployment-runtime-versions)
- [update-pom-to-next-pre-release](#update-pom-to-next-pre-release)
- [update-project-base-tag](#update-project-base-tag)
Expand Down Expand Up @@ -1103,6 +1103,28 @@ Updates pom files to the provided version
version: 1.0.0-alpha.1
```

### md-toc

Generates a Markdown table of contents for a file.

```yaml
- uses: Alfresco/alfresco-build-tools/.github/actions/md-toc@ref
with:
md_src: 'LICENSE.md README.md docs/*.md'
bullets: '-'
depth: '4'
md_toc_version: 1.2.0
node_install: 'false'
```

For ToC to be inserted in your file, it needs to contain the HTML comment below:

```markdown
## Table of Contents
<!-- toc -->
```

### nexus-move-artifacts

Moves artifacts from one repository to another on Nexus 3, identified by a particular group and version.
Expand Down Expand Up @@ -1629,28 +1651,6 @@ Uploads a file to a Slack channel.
file-title: 'file description' # optional
```

### md-toc

Generates a Markdown table of contents for a file.

```yaml
- uses: Alfresco/alfresco-build-tools/.github/actions/md-toc@ref
with:
md_src: 'docs/README.md'
bullets: '-'
depth: '4'
md_toc_version: 1.2.0
node_install: 'false'
```

For ToC to be inserted in your file, it needs to contain the HTML comment below:

```markdown
## Table of Contents
<!-- toc -->
```

### update-deployment-runtime-versions

For more information, see [update-deployment-runtime-versions](../.github/actions/update-deployment-runtime-versions/action.yml).
Expand Down

0 comments on commit 7bfe837

Please sign in to comment.