docusaurus/website/docs/api/plugins
Erick Zhao c86dfbda61
feat(v2): allow specifying TOC max depth (themeConfig + frontMatter) (#5578)
* feat: add all TOC levels to MDX loader

* feat: add theme-level config for heading depth

* test: add remark MDX loader test

* fix: limit maxDepth validation to H2 - H6

* refactor: set default `maxDepth` using `joi`

* refactor: `maxDepth` -> `maxHeadingLevel

* refactor: invert underlying TOC depth API

* refactor: make TOC algorithm level-aware

* feat: add support for per-doc TOC heading levels

* feat: support document-level heading levels for blog

* fix: correct validation for toc level frontmatter

* fix: ensure TOC doesn't generate redundant DOM

* perf: simpler TOC heading search alg

* docs: document heading level props for `TOCInline`

* Update website/docs/guides/markdown-features/markdown-features-inline-toc.mdx

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

* docs: fix docs (again)

* create dedicated  test file for heading searching logic: exhaustive tests will be simpler to write

* toc search: add real-world test

* fix test

* add dogfooding tests for toc min/max

* add test for min/max toc frontmatter

* reverse min/max order

* add theme minHeadingLevel + tests

* simpler TOC rendering logic

* simplify TOC implementation (temp, WIP)

* reverse unnatural order for minHeadingLevel/maxHeadingLevel

* add TOC dogfooding tests to all content plugins

* expose toc min/max heading level frontmatter to all 3 content plugins

* refactor blogLayout: accept toc ReactElement directly

* move toc utils to theme-common

* add tests for filterTOC

* create new generic TOCItems component

* useless css file copied

* fix toc highlighting className conflicts

* update doc

* fix types

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-09-29 11:19:11 +02:00
..
overview.md docs(v2): use explicit heading IDs (#4460) 2021-03-19 11:00:41 +01:00
plugin-client-redirects.md docs(v2): use explicit heading IDs (#4460) 2021-03-19 11:00:41 +01:00
plugin-content-blog.md feat(v2): allow specifying TOC max depth (themeConfig + frontMatter) (#5578) 2021-09-29 11:19:11 +02:00
plugin-content-docs.md feat(v2): allow specifying TOC max depth (themeConfig + frontMatter) (#5578) 2021-09-29 11:19:11 +02:00
plugin-content-pages.md docs: try to make plugin/preset config less confusing (#5313) 2021-08-10 12:32:44 +02:00
plugin-debug.md chore: rename v2.docusaurus.io urls after domain switch + redirect + cleanups (#4490) 2021-03-22 20:57:49 +01:00
plugin-google-analytics.md feat(v2): add trailingSlash config option (#4908) 2021-06-09 19:59:39 +02:00
plugin-google-gtag.md docs(v2): specify google-analytics and gtag plugins (#4703) 2021-05-04 16:46:07 +02:00
plugin-ideal-image.md docs(v2): GIF format is not suported (#5133) 2021-07-12 19:40:42 +02:00
plugin-pwa.md docs(v2): use explicit heading IDs (#4460) 2021-03-19 11:00:41 +01:00
plugin-sitemap.md docs(v2): use explicit heading IDs (#4460) 2021-03-19 11:00:41 +01:00