{"id":28800969,"url":"https://github.com/takagiy/index-markdown-pages","last_synced_at":"2025-07-31T01:36:08.175Z","repository":{"id":291244830,"uuid":"977046100","full_name":"takagiy/index-markdown-pages","owner":"takagiy","description":"An action to collect the markdown files in the repository and create an index","archived":false,"fork":false,"pushed_at":"2025-06-07T16:44:46.000Z","size":2349,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-18T07:05:38.696Z","etag":null,"topics":["ci","continuous-integration","documentation","github-actions","markdown"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/index-markdown-pages","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/takagiy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-05-03T09:55:43.000Z","updated_at":"2025-06-07T16:44:50.000Z","dependencies_parsed_at":"2025-05-03T11:23:19.398Z","dependency_job_id":"bc7c8fd5-0116-4f49-a4d4-17db30cbe899","html_url":"https://github.com/takagiy/index-markdown-pages","commit_stats":null,"previous_names":["takagiy/index-markdown-pages"],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/takagiy/index-markdown-pages","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/takagiy%2Findex-markdown-pages","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/takagiy%2Findex-markdown-pages/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/takagiy%2Findex-markdown-pages/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/takagiy%2Findex-markdown-pages/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/takagiy","download_url":"https://codeload.github.com/takagiy/index-markdown-pages/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/takagiy%2Findex-markdown-pages/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267972862,"owners_count":24174390,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-30T02:00:09.044Z","response_time":70,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ci","continuous-integration","documentation","github-actions","markdown"],"created_at":"2025-06-18T07:05:39.521Z","updated_at":"2025-07-31T01:36:08.163Z","avatar_url":"https://github.com/takagiy.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Index markdown pages\n\nAn action to collect the markdown files in the repository and create an index\n\n# Example\n\nSee example output on [example/](https://github.com/takagiy/index-markdown-pages/tree/main/example).\n\n```yaml\njobs:\n  test:\n    name: \"Create markdown index\"\n    runs-on: ubuntu-latest\n    permissions:\n      # This is required to push the changes to GitHub.\n      contents: write\n    steps:\n      - uses: actions/checkout@v4\n      - use: takagiy/index-markdown-pages@v2\n        with:\n          root-patterns: README.md\n          header: '## Index'\n```\n\n# API\n\n```yaml\n- use: takagiy/index-markdown-pages@v2\n  with:\n    # Glob patterns (separated by newlines) matching the root documents.\n    # The indexes will be written to that documents.\n    # (default: README.md)\n    root-patterns: README.md\n    # Glob patterns (separated by newlines) matching the documents to be excluded from the index.\n    # (default: '')\n    exclude-patterns: |\n        dist/**/*\n        public/**/*\n    # Header to be added to the index.\n    # (default: '## Index')\n    header: '## Index'\n    # Whether to automatically commit the changes.\n    # (default: true)\n    commit: true\n    # Branch to commit the changes to.\n    # (default: ${{ github.event.pull_request.ref || github.event.push.ref || github.ref }})\n    commit-on: ${{ github.event.pull_request.ref || github.event.push.ref || github.ref }}\n    # Commit message.\n    # (default: 'docs: Update index')\n    commit-message: 'docs: Update index'\n    # Whether to automatically push the changes to the remote repository.\n    # (default: true)\n    push: true\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftakagiy%2Findex-markdown-pages","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftakagiy%2Findex-markdown-pages","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftakagiy%2Findex-markdown-pages/lists"}