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
Sébastien Lorber
553f914639
feat: TypeScript presets/plugins should expose Options typing ( #5456 )
...
* each TS plugin should export option types + preset export option / themeConfig types + remove TS typechecking for the bootstrap theme
* each TS plugin should export option types + preset export option / themeConfig types + remove TS typechecking for the bootstrap theme
* fix remaining TS errors
* fix remaining TS errors
* TS fix
* Add JSDoc type annotations to init templates and TS docs
* missing title char
2021-09-01 12:14:40 +02:00
Sam Zhou
5e73c72f26
chore(v2): Fix linter warnings ( #4442 )
...
* chore(v2): Fix linter warnings
223 warnings to 145 warnings
* Remove explicit type annotations
* Do not prefetch when targetLink == null
2021-03-17 17:28:42 +01:00
Sébastien Lorber
41ef333e47
feat(v2): inline table-of-contents + refactor TOC ( #3904 )
...
* Add TOCInline theme component
* Add TOCInline theme component doc + migration guide
* remove useless getPathsToWatch on classic theme
* rename rightToc to toc
* add temp theme-bootstrap TOCInline comp to fix build issue
2020-12-11 16:30:53 +01:00
Sébastien Lorber
637fe0087d
feat(v2): add TOC to markdown pages #3529
2020-10-03 17:33:36 +02:00
Bartosz Kaszubowski
f9944cb2fc
feat(v2): add optional custom wrapper class name for pages based on theme classic Layout ( #3457 )
...
* feat(v2): add optional custom wrapper class name for pages based on theme classic Layout
* feat(v2): add optional custom wrapper class name for markdown pages
* fix TS types
2020-09-23 15:38:17 +03:00
Sam Zhou
c8d6e418ff
feat(v2): Provide type definitions for MDXPage from page plugin ( #3354 )
2020-08-28 14:58:32 +02:00
