{"id":13620412,"url":"https://github.com/minoic/markdown-auto-catalog","last_synced_at":"2026-02-03T14:12:05.441Z","repository":{"id":61425308,"uuid":"551201117","full_name":"minoic/markdown-auto-catalog","owner":"minoic","description":"GitHub action automatically update folder-based table of contents (TOC) in documents.","archived":false,"fork":false,"pushed_at":"2024-06-11T01:49:53.000Z","size":1458,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-22T16:03:14.122Z","etag":null,"topics":["bot","document","markdown","toc","toc-generator"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/minoic.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}},"created_at":"2022-10-14T01:55:50.000Z","updated_at":"2025-05-04T22:56:42.000Z","dependencies_parsed_at":"2024-01-14T08:06:31.380Z","dependency_job_id":null,"html_url":"https://github.com/minoic/markdown-auto-catalog","commit_stats":{"total_commits":37,"total_committers":3,"mean_commits":"12.333333333333334","dds":0.4054054054054054,"last_synced_commit":"bb3843a81673b586574f5b646db62995f715eb35"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/minoic/markdown-auto-catalog","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minoic%2Fmarkdown-auto-catalog","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minoic%2Fmarkdown-auto-catalog/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minoic%2Fmarkdown-auto-catalog/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minoic%2Fmarkdown-auto-catalog/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/minoic","download_url":"https://codeload.github.com/minoic/markdown-auto-catalog/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minoic%2Fmarkdown-auto-catalog/sbom","scorecard":{"id":648661,"data":{"date":"2025-08-11","repo":{"name":"github.com/minoic/markdown-auto-catalog","commit":"e1ce0daac8e41d059d511dc51c70fbcf994425eb"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.4,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":0,"reason":"Found 0/24 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: third-party GitHubAction not pinned by hash: .github/workflows/catalog.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/minoic/markdown-auto-catalog/catalog.yml/master?enable=pin","Info:   0 out of   1 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/catalog.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: GNU General Public License v3.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 6 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-21T12:52:45.973Z","repository_id":61425308,"created_at":"2025-08-21T12:52:45.974Z","updated_at":"2025-08-21T12:52:45.974Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29047516,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-03T10:09:22.136Z","status":"ssl_error","status_checked_at":"2026-02-03T10:09:16.814Z","response_time":96,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["bot","document","markdown","toc","toc-generator"],"created_at":"2024-08-01T21:00:55.475Z","updated_at":"2026-02-03T14:12:05.411Z","avatar_url":"https://github.com/minoic.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"\n# markdown-auto-catalog\nGitHub action automatically update folder-based table of contents in documents.\n\nThis robot will help you scan the folder and add the directory in the form of a list to the specified location of the specified document.\n\nAn example repository using this tool: [minoic/stackoverflow-go-top-qa](https://github.com/minoic/stackoverflow-go-top-qa)\n\n## Usage\n\nStep 1\n\nAdd two tags `\u003c!-- catalog --\u003e` to the appropriate location in the document where you want to add the catalog. This way, when the GitHub Action workflow job is completed, the catalog will be automatically added or updated between these two tags.\n\n```markdown\n## Catalog\n\n\u003c!-- catalog --\u003e\n\n\u003c!-- catalog --\u003e\n``` \n\nStep 2\n\nAdd workflow in your project by creating workflow file such as `.github/workflows/catalog.yml` with the code below:\n\n```yaml\nname: markdown-auto-catalog\n\non:\n  push:\n    branches: [ \"master\" ]\n  workflow_dispatch:\n\njobs:\n  build:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: minoic/markdown-auto-catalog@v1.0.2\n        with:\n          content-path: 'test/folder'\n          document-path: 'test/README.md'\n          filter: '\\(.*\\).md'\n        continue-on-error: true\n```\n\n| Argument      | Description | Required | Default |\n|---------------|--------|----------|--------|\n| content-path  |   Path of the documents to be listed in catalog.     | Yes      |        |\n| document-path |     Path of the catalog document.   | Yes      |        |\n| filter        |     Filename Regex filter   | Optional |    \\\\(.*\\\\).md    |\n\n## Preview\n\n**Code view:**\n\n```markdown\n## Catalog\n\n\u003c!-- catalog --\u003e\n\n- [0-intro.md](folder/0-intro.md)\n- 1-chapter1\n  - [article1.md](folder/1-chapter1/article1.md)\n  - [article2.md](folder/1-chapter1/article2.md)\n  - [article3.md](folder/1-chapter1/article3.md)\n  - sub-catalog\n    - [sub-catalog.md](folder/1-chapter1/sub-catalog/sub-catalog.md)\n- 2-chapter2\n  - [article4.md](folder/2-chapter2/article4.md)\n  - [article5.md](folder/2-chapter2/article5.md)\n  - [article6.md](folder/2-chapter2/article6.md)\n  - [article7.md](folder/2-chapter2/article7.md)\n\n\u003c!-- catalog --\u003e\n```\n\n**Reader view:**\n\n\u003e## Catalog\n\u003e \n\u003e \u003c!-- catalog --\u003e\n\u003e \n\u003e - [0-intro.md](folder/0-intro.md)\n\u003e - 1-chapter1\n\u003e   - [article1.md](folder/1-chapter1/article1.md)\n\u003e   - [article2.md](folder/1-chapter1/article2.md)\n\u003e   - [article3.md](folder/1-chapter1/article3.md)\n\u003e   - sub-catalog\n\u003e     - [sub-catalog.md](folder/1-chapter1/sub-catalog/sub-catalog.md)\n\u003e - 2-chapter2\n\u003e   - [article4.md](folder/2-chapter2/article4.md)\n\u003e   - [article5.md](folder/2-chapter2/article5.md)\n\u003e   - [article6.md](folder/2-chapter2/article6.md)\n\u003e   - [article7.md](folder/2-chapter2/article7.md)\n\u003e \n\u003e \u003c!-- catalog --\u003e\n\n## Notice\n\n1. When there are no files to change, there will be no PRs.\n2. The previous PR is updated when it has not been merged and there are new changes.\n3. If you don't like the red × when no files to change, add `continue-on-error: true` below the step.\n4. Empty folders or folders containing filtered files are also displayed in the directory, so save unnecessary files in other directories.\n5. Tables of contents are sorted in ascending lexicographical order and can be named using a format such as \"01 - article title.md\" to ensure the table of contents is in the order you want.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fminoic%2Fmarkdown-auto-catalog","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fminoic%2Fmarkdown-auto-catalog","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fminoic%2Fmarkdown-auto-catalog/lists"}