feat(v2): inline table-of-contents + refactor TOC #3904
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
✔️ Deploy preview for docusaurus-2 ready! 🔨 Explore the source changes: 2127893 🔍 Inspect the deploy logs: https://app.netlify.com/sites/docusaurus-2/deploys/5fd38cb5a7cc8100086daa56 😎 Browse the preview: https://deploy-preview-3904--docusaurus-2.netlify.app |
|
Size Change: +15 B (0%) Total Size: 154 kB ℹ️ View Unchanged
|
slorber
added
the
pr: breaking change
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-3904--docusaurus-2.netlify.app/classic/ |
slorber
added a commit
to jest-website-migration/jest
that referenced
this pull request
Dec 11, 2020
|
Is it possible to add additional indentation levels beyond H3? |
|
Not currently but please open an issue and we'll add support for this later
Le sam. 12 déc. 2020 à 07:52, Mitch <notifications@github.com> a écrit :
… Is it possible to add additional indentation levels beyond H3?
—
You are receiving this because you modified the open/close state.
Reply to this email directly, view it on GitHub
<#3904 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAFW6PQL4FAVU2HKWZDX7RTSUMHJLANCNFSM4UWW4ZEQ>
.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Docusaurus v1 had a feature to add table of contents directly to the body of a document.
https://docusaurus.io/docs/en/doc-markdown#generating-table-of-contents
Put a
<AUTOGENERATED_TABLE_OF_CONTENTS>somewhere in a md doc, and it renders an inline TOC.This is used on Jest, and required for the v2 migration.
This is actually pretty easy to implement with MDX, as the TOC tree is already exposed to each md doc thanks to the mdx loader.
It can also display a partial TOC derived from the original TOC, and gives flexibility to the user:
Related to: #1549
Doc: https://deploy-preview-3904--docusaurus-2.netlify.app/classic/docs/markdown-features#inline-table-of-contents
Breaking changes
rightTocrenamed to justtoc(as the position of the toc depends on the theme, not always on the rightheadingstotoc.<TOC headings={rightToc}/>becomes<TOC toc={toc}/>