{"id":15140315,"url":"https://github.com/pholleran/toc-me","last_synced_at":"2025-09-11T13:31:16.509Z","repository":{"id":70780491,"uuid":"138754519","full_name":"pholleran/toc-me","owner":"pholleran","description":"A GitHub App built with Probot that runs markdown-toc","archived":false,"fork":false,"pushed_at":"2019-08-15T17:42:11.000Z","size":72,"stargazers_count":16,"open_issues_count":3,"forks_count":5,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-01-01T12:03:11.866Z","etag":null,"topics":["probot","probot-app"],"latest_commit_sha":null,"homepage":"https://github.com/apps/toc-me","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pholleran.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2018-06-26T15:02:26.000Z","updated_at":"2022-09-01T16:29:08.000Z","dependencies_parsed_at":null,"dependency_job_id":"57201c36-ebbf-42e6-b567-e7597faa6bc7","html_url":"https://github.com/pholleran/toc-me","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pholleran%2Ftoc-me","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pholleran%2Ftoc-me/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pholleran%2Ftoc-me/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pholleran%2Ftoc-me/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pholleran","download_url":"https://codeload.github.com/pholleran/toc-me/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":232651110,"owners_count":18555932,"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":["probot","probot-app"],"created_at":"2024-09-26T08:02:04.207Z","updated_at":"2025-01-05T22:53:19.464Z","avatar_url":"https://github.com/pholleran.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://dev.azure.com/pholleran/toc-me/_apis/build/status/toc-me-CI?branchName=master)](https://dev.azure.com/pholleran/toc-me/_build/latest?definitionId=6\u0026branchName=master)\n\n# toc-me\n\n\u003e A GitHub App built with [Probot](https://github.com/probot/probot) that runs [markdown-toc](https://github.com/jonschlinkert/markdown-toc)\n\n## Overview\n\nTeams often use GitHub to manage documentation. As that documentation grows navigation can become a challenge, leading to the addition of a table of contents (ToC). As the documentation is modified team members must take care to ensure the ToC links are properly nested and formatted, which can create a barrier to contribution.\n\nThis app examines each push operation for markdown files formatted to use `markdown-toc`. When such files are found, `toc-me` regenerates a new ToC for the file and inserts it in the configured location.\n\n## Setup\n\n### Deploy and configure the app\n\nThe [probot deployment docs](https://probot.github.io/docs/deployment/) can be followed to deploy your own version of `toc-me`. You will need to define an additional environment variable `APP_NAME` and populate it with the exact name of your GitHub App.\n\n### Configuring markdown files for TOC\n\n`toc-me` will run on properly configured markdown files\n\n#### Inserting a new TOC in a markdown file\n\nEdit your markdown file to include the following line where you would like the ToC inserted:\n\n```\n\u003c!-- toc --\u003e\n```\n\n#### Updating an existing TOC\n\n`toc-me` will automatically update a ToC previously generated by the app.\n\n### Configuration options\n\n`toc-me` supports the optional use of a `toc.yml` configuration file in the `.github` directory of repositories in wihch the app is installed. Parameters [supported by markdown-toc](https://github.com/jonschlinkert/markdown-toc#options) can be defined in the file.\n\nFor example:\n\n```yaml\nappend: 'this string will be appended to the end of the ToC'\n```\n\n## Contributing\n\nIf you have suggestions for how `toc-me` could be improved, or want to report a bug, open an issue! We'd love all and any contributions.\n\nFor more, check out the [Contributing Guide](CONTRIBUTING.md).\n\n## License\n\n[ISC](LICENSE) © 2018 Philip Holleran \u003cpholleran@github.com\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpholleran%2Ftoc-me","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpholleran%2Ftoc-me","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpholleran%2Ftoc-me/lists"}