diff --git a/packages/docusaurus-mdx-loader/src/index.js b/packages/docusaurus-mdx-loader/src/index.js
index 64a666bbd1..5023a09e77 100644
--- a/packages/docusaurus-mdx-loader/src/index.js
+++ b/packages/docusaurus-mdx-loader/src/index.js
@@ -12,13 +12,13 @@ const emoji = require('remark-emoji');
const matter = require('gray-matter');
const stringifyObject = require('stringify-object');
const slug = require('./remark/slug');
-const rightToc = require('./remark/rightToc');
+const toc = require('./remark/toc');
const transformImage = require('./remark/transformImage');
const transformLinks = require('./remark/transformLinks');
const DEFAULT_OPTIONS = {
rehypePlugins: [],
- remarkPlugins: [emoji, slug, rightToc],
+ remarkPlugins: [emoji, slug, toc],
};
module.exports = async function docusaurusMdxLoader(fileString) {
diff --git a/packages/docusaurus-mdx-loader/src/remark/rightToc/__tests__/__snapshots__/index.test.js.snap b/packages/docusaurus-mdx-loader/src/remark/toc/__tests__/__snapshots__/index.test.js.snap
similarity index 95%
rename from packages/docusaurus-mdx-loader/src/remark/rightToc/__tests__/__snapshots__/index.test.js.snap
rename to packages/docusaurus-mdx-loader/src/remark/toc/__tests__/__snapshots__/index.test.js.snap
index bdc25c3df4..36725f1c98 100644
--- a/packages/docusaurus-mdx-loader/src/remark/rightToc/__tests__/__snapshots__/index.test.js.snap
+++ b/packages/docusaurus-mdx-loader/src/remark/toc/__tests__/__snapshots__/index.test.js.snap
@@ -1,7 +1,7 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`inline code should be escaped 1`] = `
-"export const rightToc = [
+"export const toc = [
{
value: '<Head />
',
id: 'head-',
@@ -43,7 +43,7 @@ exports[`inline code should be escaped 1`] = `
`;
exports[`non text phrasing content 1`] = `
-"export const rightToc = [
+"export const toc = [
{
value: 'Emphasis',
id: 'emphasis',
diff --git a/packages/docusaurus-mdx-loader/src/remark/rightToc/__tests__/fixtures/empty-headings.md b/packages/docusaurus-mdx-loader/src/remark/toc/__tests__/fixtures/empty-headings.md
similarity index 100%
rename from packages/docusaurus-mdx-loader/src/remark/rightToc/__tests__/fixtures/empty-headings.md
rename to packages/docusaurus-mdx-loader/src/remark/toc/__tests__/fixtures/empty-headings.md
diff --git a/packages/docusaurus-mdx-loader/src/remark/rightToc/__tests__/fixtures/inline-code.md b/packages/docusaurus-mdx-loader/src/remark/toc/__tests__/fixtures/inline-code.md
similarity index 100%
rename from packages/docusaurus-mdx-loader/src/remark/rightToc/__tests__/fixtures/inline-code.md
rename to packages/docusaurus-mdx-loader/src/remark/toc/__tests__/fixtures/inline-code.md
diff --git a/packages/docusaurus-mdx-loader/src/remark/rightToc/__tests__/fixtures/insert-below-imports.md b/packages/docusaurus-mdx-loader/src/remark/toc/__tests__/fixtures/insert-below-imports.md
similarity index 100%
rename from packages/docusaurus-mdx-loader/src/remark/rightToc/__tests__/fixtures/insert-below-imports.md
rename to packages/docusaurus-mdx-loader/src/remark/toc/__tests__/fixtures/insert-below-imports.md
diff --git a/packages/docusaurus-mdx-loader/src/remark/rightToc/__tests__/fixtures/just-content.md b/packages/docusaurus-mdx-loader/src/remark/toc/__tests__/fixtures/just-content.md
similarity index 100%
rename from packages/docusaurus-mdx-loader/src/remark/rightToc/__tests__/fixtures/just-content.md
rename to packages/docusaurus-mdx-loader/src/remark/toc/__tests__/fixtures/just-content.md
diff --git a/packages/docusaurus-mdx-loader/src/remark/rightToc/__tests__/fixtures/name-exist.md b/packages/docusaurus-mdx-loader/src/remark/toc/__tests__/fixtures/name-exist.md
similarity index 50%
rename from packages/docusaurus-mdx-loader/src/remark/rightToc/__tests__/fixtures/name-exist.md
rename to packages/docusaurus-mdx-loader/src/remark/toc/__tests__/fixtures/name-exist.md
index 4304c8f3e4..86d9aac2fd 100644
--- a/packages/docusaurus-mdx-loader/src/remark/rightToc/__tests__/fixtures/name-exist.md
+++ b/packages/docusaurus-mdx-loader/src/remark/toc/__tests__/fixtures/name-exist.md
@@ -1,4 +1,4 @@
-export const rightToc = ['replaceMe'];
+export const toc = ['replaceMe'];
## Thanos
diff --git a/packages/docusaurus-mdx-loader/src/remark/rightToc/__tests__/fixtures/non-text-content.md b/packages/docusaurus-mdx-loader/src/remark/toc/__tests__/fixtures/non-text-content.md
similarity index 100%
rename from packages/docusaurus-mdx-loader/src/remark/rightToc/__tests__/fixtures/non-text-content.md
rename to packages/docusaurus-mdx-loader/src/remark/toc/__tests__/fixtures/non-text-content.md
diff --git a/packages/docusaurus-mdx-loader/src/remark/rightToc/__tests__/index.test.js b/packages/docusaurus-mdx-loader/src/remark/toc/__tests__/index.test.js
similarity index 96%
rename from packages/docusaurus-mdx-loader/src/remark/rightToc/__tests__/index.test.js
rename to packages/docusaurus-mdx-loader/src/remark/toc/__tests__/index.test.js
index c5931ff5bb..f55c0be063 100644
--- a/packages/docusaurus-mdx-loader/src/remark/rightToc/__tests__/index.test.js
+++ b/packages/docusaurus-mdx-loader/src/remark/toc/__tests__/index.test.js
@@ -37,7 +37,7 @@ test('inline code should be escaped', async () => {
test('text content', async () => {
const result = await processFixture('just-content');
expect(result).toMatchInlineSnapshot(`
- "export const rightToc = [
+ "export const toc = [
{
value: 'Endi',
id: 'endi',
@@ -83,7 +83,7 @@ test('text content', async () => {
test('should export even with existing name', async () => {
const result = await processFixture('name-exist');
expect(result).toMatchInlineSnapshot(`
- "export const rightToc = [
+ "export const toc = [
{
value: 'Thanos',
id: 'thanos',
@@ -167,7 +167,7 @@ test('should insert below imports', async () => {
import somethingElse from 'something-else';
- export const rightToc = [
+ export const toc = [
{
value: 'Title',
id: 'title',
@@ -200,7 +200,7 @@ test('should insert below imports', async () => {
test('empty headings', async () => {
const result = await processFixture('empty-headings');
expect(result).toMatchInlineSnapshot(`
- "export const rightToc = [];
+ "export const toc = [];
# Ignore this
diff --git a/packages/docusaurus-mdx-loader/src/remark/rightToc/index.js b/packages/docusaurus-mdx-loader/src/remark/toc/index.js
similarity index 97%
rename from packages/docusaurus-mdx-loader/src/remark/rightToc/index.js
rename to packages/docusaurus-mdx-loader/src/remark/toc/index.js
index a45f941e79..949a7467bc 100644
--- a/packages/docusaurus-mdx-loader/src/remark/rightToc/index.js
+++ b/packages/docusaurus-mdx-loader/src/remark/toc/index.js
@@ -59,7 +59,7 @@ const getOrCreateExistingTargetIndex = (children, name) => {
};
const plugin = (options = {}) => {
- const name = options.name || 'rightToc';
+ const name = options.name || 'toc';
const transformer = (node) => {
const headings = search(node);
diff --git a/packages/docusaurus-mdx-loader/src/remark/rightToc/search.js b/packages/docusaurus-mdx-loader/src/remark/toc/search.js
similarity index 95%
rename from packages/docusaurus-mdx-loader/src/remark/rightToc/search.js
rename to packages/docusaurus-mdx-loader/src/remark/toc/search.js
index bafac24e8e..0821ec6d5f 100644
--- a/packages/docusaurus-mdx-loader/src/remark/rightToc/search.js
+++ b/packages/docusaurus-mdx-loader/src/remark/toc/search.js
@@ -11,7 +11,7 @@ const toString = require('mdast-util-to-string');
const visit = require('unist-util-visit');
const {toValue} = require('../utils');
-/** @typedef {import('@docusaurus/types').MarkdownRightTableOfContents} TOC */
+/** @typedef {import('@docusaurus/types').TOCItem} TOC */
/** @typedef {import('unist').Node} Node */
/**
diff --git a/packages/docusaurus-plugin-content-blog/index.d.ts b/packages/docusaurus-plugin-content-blog/index.d.ts
index ce5f0baf59..a8ff397af3 100644
--- a/packages/docusaurus-plugin-content-blog/index.d.ts
+++ b/packages/docusaurus-plugin-content-blog/index.d.ts
@@ -24,7 +24,7 @@ declare module '@theme/BlogSidebar' {
}
declare module '@theme/BlogPostPage' {
- import type {MarkdownRightTableOfContents} from '@docusaurus/types';
+ import type {TOCItem} from '@docusaurus/types';
import type {BlogSidebar} from '@theme/BlogSidebar';
export type FrontMatter = {
@@ -61,7 +61,7 @@ declare module '@theme/BlogPostPage' {
export type Content = {
readonly frontMatter: FrontMatter;
readonly metadata: Metadata;
- readonly rightToc: readonly MarkdownRightTableOfContents[];
+ readonly toc: readonly TOCItem[];
(): JSX.Element;
};
diff --git a/packages/docusaurus-plugin-content-docs/src/plugin-content-docs.d.ts b/packages/docusaurus-plugin-content-docs/src/plugin-content-docs.d.ts
index 48073603cd..48e5726ddd 100644
--- a/packages/docusaurus-plugin-content-docs/src/plugin-content-docs.d.ts
+++ b/packages/docusaurus-plugin-content-docs/src/plugin-content-docs.d.ts
@@ -46,7 +46,7 @@ declare module '@docusaurus/plugin-content-docs-types' {
}
declare module '@theme/DocItem' {
- import type {MarkdownRightTableOfContents} from '@docusaurus/types';
+ import type {TOCItem} from '@docusaurus/types';
export type DocumentRoute = {
readonly component: () => JSX.Element;
@@ -80,7 +80,7 @@ declare module '@theme/DocItem' {
readonly content: {
readonly frontMatter: FrontMatter;
readonly metadata: Metadata;
- readonly rightToc: readonly MarkdownRightTableOfContents[];
+ readonly toc: readonly TOCItem[];
(): JSX.Element;
};
};
diff --git a/packages/docusaurus-plugin-content-pages/src/plugin-content-pages.d.ts b/packages/docusaurus-plugin-content-pages/src/plugin-content-pages.d.ts
index 57ef441323..4bc3a58094 100644
--- a/packages/docusaurus-plugin-content-pages/src/plugin-content-pages.d.ts
+++ b/packages/docusaurus-plugin-content-pages/src/plugin-content-pages.d.ts
@@ -6,7 +6,7 @@
*/
declare module '@theme/MDXPage' {
- import type {MarkdownRightTableOfContents} from '@docusaurus/types';
+ import type {TOCItem} from '@docusaurus/types';
export type Props = {
readonly content: {
@@ -17,7 +17,7 @@ declare module '@theme/MDXPage' {
readonly hide_table_of_contents?: string;
};
readonly metadata: {readonly permalink: string};
- readonly rightToc: readonly MarkdownRightTableOfContents[];
+ readonly toc: readonly TOCItem[];
(): JSX.Element;
};
};
diff --git a/packages/docusaurus-theme-bootstrap/src/theme/TOCInline/index.tsx b/packages/docusaurus-theme-bootstrap/src/theme/TOCInline/index.tsx
new file mode 100644
index 0000000000..e231482602
--- /dev/null
+++ b/packages/docusaurus-theme-bootstrap/src/theme/TOCInline/index.tsx
@@ -0,0 +1,14 @@
+/**
+ * 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.
+ */
+
+import React from 'react';
+
+function TOCInline(_props: any): JSX.Element {
+ return