{"id":13929672,"url":"https://github.com/badboy/mdbook-toc","last_synced_at":"2025-04-04T09:07:58.645Z","repository":{"id":35010634,"uuid":"141603390","full_name":"badboy/mdbook-toc","owner":"badboy","description":"A preprocessor for mdbook to add inline Table of Contents support.","archived":false,"fork":false,"pushed_at":"2024-04-04T10:16:43.000Z","size":340,"stargazers_count":179,"open_issues_count":3,"forks_count":20,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-01T16:18:35.978Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/badboy.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2018-07-19T16:10:16.000Z","updated_at":"2025-03-27T09:33:27.000Z","dependencies_parsed_at":"2023-12-13T11:39:37.224Z","dependency_job_id":"81d6b0ca-f6a5-4651-9653-5725db621188","html_url":"https://github.com/badboy/mdbook-toc","commit_stats":{"total_commits":123,"total_committers":7,"mean_commits":"17.571428571428573","dds":0.04878048780487809,"last_synced_commit":"c78210ea72deaea938c8947ab1bec24b14653ea2"},"previous_names":[],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badboy%2Fmdbook-toc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badboy%2Fmdbook-toc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badboy%2Fmdbook-toc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badboy%2Fmdbook-toc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/badboy","download_url":"https://codeload.github.com/badboy/mdbook-toc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247149501,"owners_count":20891954,"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":[],"created_at":"2024-08-07T18:02:28.915Z","updated_at":"2025-04-04T09:07:58.619Z","avatar_url":"https://github.com/badboy.png","language":"Rust","funding_links":[],"categories":["others"],"sub_categories":[],"readme":"# mdbook-toc\n\nA preprocessor for [mdbook][] to add inline Table of Contents support.\n\n[mdbook]: https://github.com/rust-lang-nursery/mdBook\n\nIt turns this marker:\n\n```md\n\u003c!-- toc --\u003e\n```\n\ninto a Table of Contents based on headings of the chapter following the marker.\n\n## Installation\n\nIf you want to use only this preprocessor, install the tool:\n\n```sh\ncargo install mdbook-toc\n```\n\nAdd it as a preprocessor to your `book.toml`:\n\n```toml\n[preprocessor.toc]\ncommand = \"mdbook-toc\"\nrenderer = [\"html\"]\n```\n\nFinally, build your book as normal:\n\n```sh\nmdbook path/to/book\n```\n\n## Configuration\n\n### Custom TOC marker\n\nThe default marker is:\n\n```md\n\u003c!-- toc --\u003e\n```\n\nIf you wish to use a different marker, such as the GitLab marker `[[_TOC_]]`, you must add the following settings to your `book.toml`.\n\n```toml\n[preprocessor.toc]\nmarker = \"[[_TOC_]]\"\n```\n\nYou can also use multi-line markers such as the GitHub marker, which is:\n\n```md\n* auto-gen TOC;\n{:toc}\n```\n\nConfigure the string with a newline:\n\n```toml\n[preprocessor.toc]\nmarker = \"* auto-gen TOC;\\n{:toc}\"\n```\n\nor with multi-line strings:\n\n```toml\n[preprocessor.toc]\nmarker = \"\"\"* auto-gen TOC;\n{:toc}\"\"\"\n```\n\n### Maximum header level\n\nBy default the ToC will include headings up to level 4 (`####`).\nThis can be configured in your `book.toml` as follows:\n\n```toml\n[preprocessor.toc]\nmax-level = 4\n```\n\n## License\n\nMPL. See [LICENSE](LICENSE).  \nCopyright (c) 2018-2020 Jan-Erik Rediger \u003cjanerik@fnordig.de\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbadboy%2Fmdbook-toc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbadboy%2Fmdbook-toc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbadboy%2Fmdbook-toc/lists"}