{"id":15700251,"url":"https://github.com/somajitdey/tocgen","last_synced_at":"2025-05-12T13:12:59.323Z","repository":{"id":163920181,"uuid":"407883514","full_name":"SomajitDey/tocgen","owner":"SomajitDey","description":"Markdown Table of Contents Generator","archived":false,"fork":false,"pushed_at":"2021-09-23T11:39:18.000Z","size":20,"stargazers_count":6,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-12T13:12:45.887Z","etag":null,"topics":["bash","documentation","inline-editor","markdown","md","sed","shell-script","table-of-contents","toc-generator","typora"],"latest_commit_sha":null,"homepage":"","language":"Shell","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/SomajitDey.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-09-18T14:32:13.000Z","updated_at":"2024-08-25T18:34:29.000Z","dependencies_parsed_at":null,"dependency_job_id":"3449d0bc-cd46-409d-80ae-45cb46cb27ec","html_url":"https://github.com/SomajitDey/tocgen","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/SomajitDey%2Ftocgen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SomajitDey%2Ftocgen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SomajitDey%2Ftocgen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SomajitDey%2Ftocgen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SomajitDey","download_url":"https://codeload.github.com/SomajitDey/tocgen/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253745195,"owners_count":21957319,"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":["bash","documentation","inline-editor","markdown","md","sed","shell-script","table-of-contents","toc-generator","typora"],"created_at":"2024-10-03T19:47:01.461Z","updated_at":"2025-05-12T13:12:59.287Z","avatar_url":"https://github.com/SomajitDey.png","language":"Shell","funding_links":["https://buymeacoffee.com/SomajitDey"],"categories":[],"sub_categories":[],"readme":"# TOC Generator for Markdown documents\r\n\r\n![Bash-only](https://img.shields.io/badge/Made%20with-Bash-green) ![GNU/Linux](https://img.shields.io/badge/Platform-GNU%2FLinux-violet) ![CLI](https://img.shields.io/badge/UI-Command--line-brightgreen)\r\n\r\nThe below \"Table of Contents\" has been generated using `tocgen`.\r\n\r\n## Table of Contents  \n[![tocgen](https://img.shields.io/badge/Generated%20using-tocgen-blue)](https://github.com/SomajitDey/tocgen)  \n  - [TOC Generator for Markdown documents](#toc-generator-for-markdown-documents)  \n      - [Usage](#usage)  \n          - [Step 1](#step-1)  \n          - [Step 2](#step-2)  \n          - [Step 3](#step-3)  \n      - [Contribute](#contribute)  \n#####   \n\r\n### Usage\r\n\r\n##### Step 1\r\n\r\nPut the placeholder `[TOC]` **followed by 2 spaces and a new-line** (viz. press Enter key) wherever you want the *Table of Contents* to appear in your markdown file.\r\n\r\n##### Step 2\r\n\r\nThen simply:\r\n\r\n```bash\r\ntocgen \u003cpath to the markdown file\u003e\r\n# If path is not provided, tocgen searches its working directory for *.md files\r\n```\r\n\r\nIt does an in-place edit of the file provided. The injected \"Table of Contents\" contains a trailing blank level 5 heading. **DO NOT** delete this blank heading as `tocgen` uses it to delimit the \"Table of Contents\" during subsequent updates (see below).\r\n\r\n##### Step 3\r\n\r\nEdit your document as necessary - adding, editing and removing headings. When you finish editing, in order to update the \"Table of Contents\", simply repeat the command given above.\r\n\r\n### Contribute\r\n\r\nReport [bugs](https://github.com/SomajitDey/tocgen/issues) or [discuss](https://github.com/SomajitDey/tocgen/discussions) ideas and new features. [PR](https://github.com/SomajitDey/tocgen/pulls)s welcome.\r\n\r\n[![Sponsor](https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png)](https://buymeacoffee.com/SomajitDey)\r\n\r","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsomajitdey%2Ftocgen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsomajitdey%2Ftocgen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsomajitdey%2Ftocgen/lists"}