mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-07 06:07:42 +02:00
* 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>
35 lines
1,020 B
TypeScript
35 lines
1,020 B
TypeScript
/**
|
|
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*/
|
|
|
|
declare module '@docusaurus/plugin-content-pages' {
|
|
export type Options = import('./types').PluginOptions;
|
|
}
|
|
|
|
declare module '@theme/MDXPage' {
|
|
import type {TOCItem} from '@docusaurus/types';
|
|
|
|
export type Props = {
|
|
readonly content: {
|
|
readonly frontMatter: {
|
|
readonly title: string;
|
|
readonly description: string;
|
|
readonly wrapperClassName?: string;
|
|
/* eslint-disable camelcase */
|
|
readonly hide_table_of_contents?: string;
|
|
readonly toc_min_heading_level?: number;
|
|
readonly toc_max_heading_level?: number;
|
|
/* eslint-enable camelcase */
|
|
};
|
|
readonly metadata: {readonly permalink: string};
|
|
readonly toc: readonly TOCItem[];
|
|
(): JSX.Element;
|
|
};
|
|
};
|
|
|
|
const MDXPage: (props: Props) => JSX.Element;
|
|
export default MDXPage;
|
|
}
|