takagiy/Index Markdown Pages
Collect the markdown files in the repository and create an index
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| root-patterns | Glob patterns (separated by newlines) matching the root documents. The indexes will be written to that documents. | no | README.md |
| exclude-patterns | Glob patterns (separated by newlines) matching the documents to be excluded from the index. | no | "" |
| header | Header to be added to the index. | no | ## Index |
| commit | Whether to automatically commit the changes. | no | true |
| commit-on | Branch to commit the changes to. | no | ${{ github.event.pull_request.ref || github.event.push.ref || github.ref }} |
| commit-message | Commit message. | no | docs: Update index |
| push | Whether to automatically push the changes to the remote repository. | no | true |
Outputs
no outputs