{"id":13707072,"url":"https://github.com/mmiranda/markdown-index","last_synced_at":"2026-01-14T23:52:52.373Z","repository":{"id":40460698,"uuid":"416645150","full_name":"mmiranda/markdown-index","owner":"mmiranda","description":"Generate a global index for multiple markdown files recursively","archived":false,"fork":false,"pushed_at":"2023-02-25T08:24:57.000Z","size":20985,"stargazers_count":25,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-06T00:37:30.116Z","etag":null,"topics":["go","golang","index","markdown","markdown-index","readme","table-of-contents","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mmiranda.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":"2021-10-13T08:07:32.000Z","updated_at":"2024-10-03T03:27:24.000Z","dependencies_parsed_at":"2023-12-23T17:27:18.971Z","dependency_job_id":null,"html_url":"https://github.com/mmiranda/markdown-index","commit_stats":{"total_commits":46,"total_committers":2,"mean_commits":23.0,"dds":"0.021739130434782594","last_synced_commit":"cdaff1a8519ff325396e0c32b3f44ae03b026175"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/mmiranda/markdown-index","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmiranda%2Fmarkdown-index","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmiranda%2Fmarkdown-index/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmiranda%2Fmarkdown-index/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmiranda%2Fmarkdown-index/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mmiranda","download_url":"https://codeload.github.com/mmiranda/markdown-index/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmiranda%2Fmarkdown-index/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28439574,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T22:37:52.437Z","status":"ssl_error","status_checked_at":"2026-01-14T22:37:31.496Z","response_time":107,"last_error":"SSL_read: 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":["go","golang","index","markdown","markdown-index","readme","table-of-contents","toc","toc-generator"],"created_at":"2024-08-02T22:01:17.807Z","updated_at":"2026-01-14T23:52:52.368Z","avatar_url":"https://github.com/mmiranda.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"[![made-with-Go](https://img.shields.io/badge/Made%20with-Go-1f425f.svg)](http://golang.org)\n[![codecov](https://codecov.io/gh/mmiranda/markdown-index/branch/main/graph/badge.svg?token=3B0LZEZ6XN)](https://codecov.io/gh/mmiranda/markdown-index)\n[![https://goreportcard.com/report/github.com/mmiranda/markdown-index](https://goreportcard.com/badge/github.com/mmiranda/markdown-index)](https://goreportcard.com/report/github.com/mmiranda/markdown-index)\n![[Test](https://github.com/mmiranda/markdown-index/actions/workflows/test-coverage.yml)](https://github.com/mmiranda/markdown-index/actions/workflows/test-coverage.yml/badge.svg)\n\n\n# markdown index\nMarkdown-index is a library to help you generate a global index for multiple markdown files recursively in a directory, containing a summary of every file found.\n\n![](show.gif)\n\n## Installation\n\nThe easiest way to install it is using Homebrew:\n\n```bash\nbrew tap mmiranda/apps\nbrew install markdown-index\n```\n\nIf you prefer, you also can download the latest binary on the [release section](https://github.com/mmiranda/markdown-index/releases), or simply use the pre-built [dockerfile image](#dockerfile)\n\n## Usage\nYou can use this tool using multiple ways:\n\n### Running Local\n```bash\ncd some-directory\nmarkdown-index\n```\n\n### Dockerfile\n```bash\ndocker pull ghcr.io/mmiranda/markdown-index:latest\ndocker run --rm -it -v /path/to/root/md/files:/data ghcr.io/mmiranda/markdown-index:latest\n```\n\n\nAfter running the command, a new markdown file will be created containing a summary of every other file found.\n\n## Github Actions\nYes, you can integrate this tool into your pipeline.\n\nCheck the [live-example](.github/workflows/example.yml) for GH Actions and copy it to your own repo!\n\n## Contributing\nContributions, issues, and feature requests are welcome!\n\nGive a ⭐️ if you like this project!\n\n## License\n[MIT](https://choosealicense.com/licenses/mit/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmmiranda%2Fmarkdown-index","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmmiranda%2Fmarkdown-index","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmmiranda%2Fmarkdown-index/lists"}