{"id":17982874,"url":"https://github.com/t9md/atom-markdown-toc-auto","last_synced_at":"2025-03-25T19:31:44.016Z","repository":{"id":136587384,"uuid":"66781898","full_name":"t9md/atom-markdown-toc-auto","owner":"t9md","description":"auto insert and update table of contents on save","archived":false,"fork":false,"pushed_at":"2020-08-21T09:17:03.000Z","size":67,"stargazers_count":12,"open_issues_count":0,"forks_count":6,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-20T17:38:58.307Z","etag":null,"topics":["atom","markdown-toc"],"latest_commit_sha":null,"homepage":"https://atom.io/packages/markdown-toc-auto","language":"JavaScript","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/t9md.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","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":"2016-08-28T17:41:19.000Z","updated_at":"2023-04-14T13:29:09.000Z","dependencies_parsed_at":null,"dependency_job_id":"53ff0878-7e1a-46f4-ae24-68d0c3b316ad","html_url":"https://github.com/t9md/atom-markdown-toc-auto","commit_stats":null,"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/t9md%2Fatom-markdown-toc-auto","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/t9md%2Fatom-markdown-toc-auto/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/t9md%2Fatom-markdown-toc-auto/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/t9md%2Fatom-markdown-toc-auto/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/t9md","download_url":"https://codeload.github.com/t9md/atom-markdown-toc-auto/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245530300,"owners_count":20630523,"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":["atom","markdown-toc"],"created_at":"2024-10-29T18:15:26.897Z","updated_at":"2025-03-25T19:31:44.010Z","avatar_url":"https://github.com/t9md.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# markdown-toc-auto [![Build Status](https://travis-ci.org/t9md/atom-markdown-toc-auto.svg?branch=master)](https://travis-ci.org/t9md/atom-markdown-toc-auto)\n\nAutomatically update table of contents for GitHub wiki.\n\n![gif](https://raw.githubusercontent.com/t9md/t9md/12d553f0ec6d5ae921dea200ae2250f718a09523/img/atom-markdown-toc-auto.gif)\n\n# Features\n\n- Insert TOC\n- Automatically update TOC on editor save.\n- Customizable `max` and `min` level of header to use. auto `update`, inlucde `link` or not.\n- Extract only markdown header by using Atom's scope descriptor used in syntax highlight(So ignore `#` in embedded code in markdown).\n- Generate link for GitHub wiki\n  - Remove invalid char for link\n  - Extract inner text(`xxx`) from `\u003ckbd\u003exxx\u003c/kbd\u003e` tag and use in link.\n\n# How to use\n\n1. Open markdown editor\n2. From command-palette, invoke \"Markdown Toc Auto: Insert Toc\". TOC is inserted at cursor position.\n3. Each time you save editor, TOC is automatically updated.\n4. [Optional] You can change following TOC options to control toc generation.\n  - `min`, `max`: From `min` to `max` level headers are subject to generate.\n  - `update`: If `true`, automatically updated on save.\n  - `link`: If `false`, link are not generated.\n\n# Commands\n\n- `markdown-toc-auto:insert-toc`: Insert TOC on cursor position.\n- `markdown-toc-auto:insert-toc-at-top`: Insert TOC on top of buffer.\n\n# Limitation\n\n- Currently only `source gfm` editor is supported.\n- And only checked with GitHub Wiki.\n- Header style must start with `#`.\n\n# Why I created yet another package?\n\n- As exercise.\n- Wanted to correctly ignore embedded code's comment `#`.\n- Wanted to generate valid link in github wiki(for [vim-mode-plus](https://atom.io/packages/vim-mode-plus)'s wiki).\n\n# Similar project\n\n- [markdown-toc](https://atom.io/packages/markdown-toc)\n- [atom-mdtoc](https://atom.io/packages/atom-mdtoc)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ft9md%2Fatom-markdown-toc-auto","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ft9md%2Fatom-markdown-toc-auto","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ft9md%2Fatom-markdown-toc-auto/lists"}