https://github.com/takagiy/index-markdown-pages

An action to collect the markdown files in the repository and create an index
https://github.com/takagiy/index-markdown-pages

ci continuous-integration documentation github-actions markdown

Last synced: 11 months ago
JSON representation

An action to collect the markdown files in the repository and create an index

• Host: GitHub
• URL: https://github.com/takagiy/index-markdown-pages
• Owner: takagiy
• Created: 2025-05-03T09:55:43.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-06-07T16:44:46.000Z (about 1 year ago)
• Last Synced: 2025-06-18T07:05:38.696Z (about 1 year ago)
• Topics: ci, continuous-integration, documentation, github-actions, markdown
• Language: TypeScript
• Homepage: https://github.com/marketplace/actions/index-markdown-pages
• Size: 2.24 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Index markdown pages

An action to collect the markdown files in the repository and create an index

# Example

See example output on [example/](https://github.com/takagiy/index-markdown-pages/tree/main/example).

```yaml

jobs:

  test:

    name: "Create markdown index"

    runs-on: ubuntu-latest

    permissions:

      # This is required to push the changes to GitHub.

      contents: write

    steps:

      - uses: actions/checkout@v4

      - use: takagiy/index-markdown-pages@v2

        with:

          root-patterns: README.md

          header: '## Index'

```

# API

```yaml

- use: takagiy/index-markdown-pages@v2

  with:

    # Glob patterns (separated by newlines) matching the root documents.

    # The indexes will be written to that documents.

    # (default: README.md)

    root-patterns: README.md

    # Glob patterns (separated by newlines) matching the documents to be excluded from the index.

    # (default: '')

    exclude-patterns: |

        dist/**/*

        public/**/*

    # Header to be added to the index.

    # (default: '## Index')

    header: '## Index'

    # Whether to automatically commit the changes.

    # (default: true)

    commit: true

    # Branch to commit the changes to.

    # (default: ${{ github.event.pull_request.ref || github.event.push.ref || github.ref }})

    commit-on: ${{ github.event.pull_request.ref || github.event.push.ref || github.ref }}

    # Commit message.

    # (default: 'docs: Update index')

    commit-message: 'docs: Update index'

    # Whether to automatically push the changes to the remote repository.

    # (default: true)

    push: true

```