{"id":14070610,"url":"https://github.com/DaanV2/Markdown-Action-Create-Indexes","last_synced_at":"2025-07-30T08:31:18.925Z","repository":{"id":44341425,"uuid":"347361113","full_name":"DaanV2/Markdown-Action-Create-Indexes","owner":"DaanV2","description":"The github action that creates index pages for your project, the changes still need to be submitted afterwards","archived":false,"fork":false,"pushed_at":"2024-08-01T10:22:34.000Z","size":985,"stargazers_count":10,"open_issues_count":0,"forks_count":3,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-08-01T11:51:09.630Z","etag":null,"topics":["action","github","github-action","github-actions","index","markdown"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/markdown-action-create-indexes","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DaanV2.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2021-03-13T12:12:32.000Z","updated_at":"2024-08-01T10:22:31.000Z","dependencies_parsed_at":"2023-11-08T23:37:29.423Z","dependency_job_id":"6d7efcbb-5770-4af0-8409-94c853bc616d","html_url":"https://github.com/DaanV2/Markdown-Action-Create-Indexes","commit_stats":{"total_commits":70,"total_committers":1,"mean_commits":70.0,"dds":0.0,"last_synced_commit":"b058f48ca4783435226aa7f70be7071d6092da17"},"previous_names":[],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DaanV2%2FMarkdown-Action-Create-Indexes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DaanV2%2FMarkdown-Action-Create-Indexes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DaanV2%2FMarkdown-Action-Create-Indexes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DaanV2%2FMarkdown-Action-Create-Indexes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DaanV2","download_url":"https://codeload.github.com/DaanV2/Markdown-Action-Create-Indexes/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":215155197,"owners_count":15836926,"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","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":["action","github","github-action","github-actions","index","markdown"],"created_at":"2024-08-13T07:07:56.226Z","updated_at":"2024-08-13T07:17:23.246Z","avatar_url":"https://github.com/DaanV2.png","language":"TypeScript","readme":"# Markdown-Action-Create-Indexes\n\n- [Markdown-Action-Create-Indexes](#markdown-action-create-indexes)\n  - [Inputs](#inputs)\n  - [Examples](#examples)\n  - [Example usage](#example-usage)\n\nThis Github action creates markdown index pages for your project, the changes still need to be submitted afterward.\n\nIt creates a list of each markdown file in the folders and displays it under documents. For each subfolder that has documentation, then that folder is displayed in categories.\n\n## Inputs\n\n| Parameters     | Optional | Description                                                                                                                                    |\n| -------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |\n| `folder`       | ✅        | The folder path to start at, default uses `${{github.workspace}}`                                                                              |\n| `filename`     | ✅        | The filename of the generated file. default to `index`                                                                                         |\n| `content-file` | ✅        | The filepath (relative to where the README.md or index.md) where content will be read from and input into index file, default to `.content.md` |\n| `include`      | ✅        | The files to additionaly include in the index file, follows glob pattern on the filenames, supports multiple patterns via multi-line string`   |\n| `exclude`      | ✅        | The files to exclude from the index file, follows glob pattern on the filenames, supports multiple patterns via multi-line string              |\n\n## Examples\n\n![example](https://raw.githubusercontent.com/DaanV2/Markdown-Action-Create-Indexes/main/assets/example.PNG)\n\n## Example usage\n\n```yml\n# This is a basic workflow to help you get started with Actions\n\nname: Create markdown indexes\n\n# Controls when the action will run. \non:\n  # Triggers the workflow on push or pull request events but only for the master branch\n  push:\n    branches: [ master ]\n  pull_request:\n    branches: [ master ]\n\n  # Allows you to run this workflow manually from the Actions tab\n  workflow_dispatch:\n\n# A workflow run is made up of one or more jobs that can run sequentially or in parallel\njobs:\n  # This workflow contains a single job called \"build\"\n  build:\n    # The type of runner that the job will run on\n    runs-on: ubuntu-latest\n\n    # Steps represent a sequence of tasks that will be executed as part of the job\n    steps:\n      - uses: actions/checkout@v3\n\n      # Runs a single command using the runners shell\n      - name: Generated Markdown Readmes\n        uses: DaanV2/Markdown-Action-Create-Indexes@v2.0.0\n\n      - name: Commit changes\n        continue-on-error: true\n        run: |\n          cd ${{github.workspace}}\n          git config --global user.email \"Bot@Example.com\"\n          git config --global user.name \"DaanV2 Bot\"\n          git add .\n          git commit -m \"auto: Generated markdown indexes\"\n          git push\n```\n\n**With options**\n```yaml\n- name: Generated Markdown Readmes\n  uses: DaanV2/Markdown-Action-Create-Indexes@v2.0.0\n  with: \n    folder: ${{github.workspace}}\n    filename: README.md\n    include: |\n      *.pdf\n      *.mobi\n      *.epub\n      *.zip\n```\n","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDaanV2%2FMarkdown-Action-Create-Indexes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FDaanV2%2FMarkdown-Action-Create-Indexes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDaanV2%2FMarkdown-Action-Create-Indexes/lists"}