3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-04-30 18:58:36 +02:00
Code Issues Projects Releases Packages Wiki Activity
docusaurus/website
History
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
..
_dogfooding feat(v2): allow specifying TOC max depth (themeConfig + frontMatter) (#5578) 2021-09-29 11:19:11 +02:00
blog feat(plugin-blog): multi-authors support + authors.yml global configuration (#5396) 2021-08-26 12:21:58 +02:00
community docs: add additional search options, typesense and local search (#5489) 2021-09-22 17:41:27 +02:00
docs feat(v2): allow specifying TOC max depth (themeConfig + frontMatter) (#5578) 2021-09-29 11:19:11 +02:00
src docs: Add IOTA wiki to showcase (#5610) 2021-09-28 16:35:57 +02:00
static fix: fix site unlocalized 404 pages + aggressive Netlify /assets caching (#5399) 2021-08-20 19:37:20 +02:00
versioned_docs docs: improve escape pipe in Markdown tables (#5539) 2021-09-08 14:58:48 +03:00
versioned_sidebars chore: remove beta.4 docs (already archived) (#5474) 2021-09-02 18:56:22 +02:00
babel.config.js feat(v2): Allow configuring babel via babel.config.js (#2903) 2020-06-12 11:03:00 +08:00
delayCrowdin.js chore(v2): attempt to fix crowdin dl again (#4746) 2021-05-06 19:12:13 +02:00
docusaurus.config-blog-only.js refactor: rename Git master branch to main (#5345) 2021-08-17 18:41:53 +02:00
docusaurus.config.js feat: TypeScript presets/plugins should expose Options typing (#5456) 2021-09-01 12:14:40 +02:00
netlify.toml feat(v2): Webpack 5, PostCSS 8 (#4089) 2021-04-30 18:06:53 +02:00
package.json chore: upgrade dependencies (#5608) 2021-09-24 16:36:41 +02:00
README.md feat(v2): disable optimization.removeAvailableModules for webpack performance (#1711) 2019-07-26 22:42:03 +07:00
sidebars.js feat: Markdown page-specific head metadatas (#5330) 2021-08-11 11:39:01 +02:00
sidebarsCommunity.js refactor: clean Canny integration + rename 'Feedback' to 'Feature Requests' + improve TS doc page (#5389) 2021-08-20 11:42:13 +02:00
tsconfig.json fix: fix a few TS errors (#5437) 2021-08-30 13:06:00 +02:00
versions.json chore: remove beta.4 docs (already archived) (#5474) 2021-09-02 18:56:22 +02:00
versionsArchived.json chore(v2): prepare v2.0.0-beta.6 release (#5473) 2021-09-02 18:31:42 +02:00
waitForCrowdin.js refactor: rename Git master branch to main (#5345) 2021-08-17 18:41:53 +02:00

README.md

Docusaurus 2 Website

Installation

  1. yarn install in the root of the repo (one level above this directory).
  2. In this directory, do yarn start.
  3. A browser window will open up, pointing to the docs.