From 9a785b2175811628eb4a38da4d79a1628bfa118b Mon Sep 17 00:00:00 2001 From: Alexey Pyltsyn Date: Wed, 23 Oct 2019 20:48:38 +0300 Subject: [PATCH 1/8] feat(v2): add ability expand all items in doc sidebar --- CHANGELOG-2.x.md | 1 + .../src/index.ts | 6 ++++ .../src/metadata.ts | 4 +++ .../src/types.ts | 5 +++- .../src/theme/DocPage/index.js | 3 +- .../src/theme/DocSidebar/index.js | 26 +++++++++++------ website/docs/advanced-plugins.md | 28 +++++++++++-------- website/docs/migrating-from-v1-to-v2.md | 2 ++ 8 files changed, 54 insertions(+), 21 deletions(-) diff --git a/CHANGELOG-2.x.md b/CHANGELOG-2.x.md index 2fb0f621f896..4840a34417d7 100644 --- a/CHANGELOG-2.x.md +++ b/CHANGELOG-2.x.md @@ -4,6 +4,7 @@ - Add sticky footer. - Remove empty doc sidebar container +- Add ability expand all doc items in sidebar (same as `docsSideNavCollapsible` field in v1) ## 2.0.0-alpha.30 diff --git a/packages/docusaurus-plugin-content-docs/src/index.ts b/packages/docusaurus-plugin-content-docs/src/index.ts index c40852153818..1568067fdf5b 100644 --- a/packages/docusaurus-plugin-content-docs/src/index.ts +++ b/packages/docusaurus-plugin-content-docs/src/index.ts @@ -44,6 +44,7 @@ const DEFAULT_OPTIONS: PluginOptions = { rehypePlugins: [], showLastUpdateTime: false, showLastUpdateAuthor: false, + sidebarCollapsible: true, }; export default function pluginContentDocs( @@ -76,6 +77,7 @@ export default function pluginContentDocs( editUrl, showLastUpdateAuthor, showLastUpdateTime, + sidebarCollapsible, } = options; const {siteConfig, siteDir} = context; const docsDir = contentPath; @@ -110,7 +112,9 @@ export default function pluginContentDocs( editUrl, showLastUpdateAuthor, showLastUpdateTime, + sidebarCollapsible, }); + docsMetadataRaw[metadata.id] = metadata; }), ); @@ -204,6 +208,7 @@ export default function pluginContentDocs( docsSidebars, sourceToPermalink, permalinkToSidebar, + sidebarCollapsible, }; }, @@ -238,6 +243,7 @@ export default function pluginContentDocs( const docsBaseMetadata: DocsBaseMetadata = { docsSidebars: content.docsSidebars, permalinkToSidebar: content.permalinkToSidebar, + sidebarCollapsible: content.sidebarCollapsible, }; const docsBaseRoute = normalizeUrl([ diff --git a/packages/docusaurus-plugin-content-docs/src/metadata.ts b/packages/docusaurus-plugin-content-docs/src/metadata.ts index e1bfb64f4c63..d6f52a3ae52d 100644 --- a/packages/docusaurus-plugin-content-docs/src/metadata.ts +++ b/packages/docusaurus-plugin-content-docs/src/metadata.ts @@ -23,6 +23,7 @@ type Args = { editUrl?: string; showLastUpdateAuthor?: boolean; showLastUpdateTime?: boolean; + sidebarCollapsible?: boolean; }; export default async function processMetadata({ @@ -35,6 +36,7 @@ export default async function processMetadata({ editUrl, showLastUpdateAuthor, showLastUpdateTime, + sidebarCollapsible, }: Args): Promise { const filePath = path.join(docsDir, source); @@ -130,5 +132,7 @@ export default async function processMetadata({ } } + metadata.sidebarCollapsible = sidebarCollapsible; + return metadata as MetadataRaw; } diff --git a/packages/docusaurus-plugin-content-docs/src/types.ts b/packages/docusaurus-plugin-content-docs/src/types.ts index faaf3fb7be0c..9b3408c2d924 100644 --- a/packages/docusaurus-plugin-content-docs/src/types.ts +++ b/packages/docusaurus-plugin-content-docs/src/types.ts @@ -17,6 +17,7 @@ export interface PluginOptions { editUrl?: string; showLastUpdateTime?: boolean; showLastUpdateAuthor?: boolean; + sidebarCollapsible?: boolean; } export type SidebarItemDoc = { @@ -95,6 +96,7 @@ export interface MetadataRaw extends OrderMetadata { lastUpdatedAt?: number; lastUpdatedBy?: string; hide_title?: boolean; + sidebarCollapsible?: boolean; [key: string]: any; } @@ -126,9 +128,10 @@ export interface LoadedContent { docsSidebars: Sidebar; sourceToPermalink: SourceToPermalink; permalinkToSidebar: PermalinkToSidebar; + sidebarCollapsible?: boolean; } export type DocsBaseMetadata = Pick< LoadedContent, - 'docsSidebars' | 'permalinkToSidebar' + 'docsSidebars' | 'permalinkToSidebar' | 'sidebarCollapsible' >; diff --git a/packages/docusaurus-theme-classic/src/theme/DocPage/index.js b/packages/docusaurus-theme-classic/src/theme/DocPage/index.js index cbcdecb1008c..90de135311f5 100644 --- a/packages/docusaurus-theme-classic/src/theme/DocPage/index.js +++ b/packages/docusaurus-theme-classic/src/theme/DocPage/index.js @@ -17,7 +17,7 @@ import styles from './styles.module.css'; function DocPage(props) { const {route, docsMetadata, location} = props; - const {permalinkToSidebar, docsSidebars} = docsMetadata; + const {permalinkToSidebar, docsSidebars, sidebarCollapsible} = docsMetadata; const sidebar = permalinkToSidebar[location.pathname.replace(/\/$/, '')]; return ( @@ -29,6 +29,7 @@ function DocPage(props) { docsSidebars={docsSidebars} location={location} sidebar={sidebar} + sidebarCollapsible={sidebarCollapsible} /> )} diff --git a/packages/docusaurus-theme-classic/src/theme/DocSidebar/index.js b/packages/docusaurus-theme-classic/src/theme/DocSidebar/index.js index 70e72af3adb8..2e863bb1711a 100644 --- a/packages/docusaurus-theme-classic/src/theme/DocSidebar/index.js +++ b/packages/docusaurus-theme-classic/src/theme/DocSidebar/index.js @@ -14,7 +14,7 @@ import styles from './styles.module.css'; const MOBILE_TOGGLE_SIZE = 24; -function DocSidebarItem({item, onItemClick}) { +function DocSidebarItem({item, onItemClick, collapsible}) { const {items, href, label, type} = item; const [collapsed, setCollapsed] = useState(item.collapsed); const [prevCollapsedProp, setPreviousCollapsedProp] = useState(null); @@ -36,11 +36,12 @@ function DocSidebarItem({item, onItemClick}) { })} key={label}> setCollapsed(!collapsed)}> + onClick={collapsible ? () => setCollapsed(!collapsed) : undefined}> {label} @@ -95,7 +97,12 @@ function mutateSidebarCollapsingState(item, location) { function DocSidebar(props) { const [showResponsiveSidebar, setShowResponsiveSidebar] = useState(false); - const {docsSidebars, location, sidebar: currentSidebar} = props; + const { + docsSidebars, + location, + sidebar: currentSidebar, + sidebarCollapsible, + } = props; if (!currentSidebar) { return null; @@ -109,9 +116,11 @@ function DocSidebar(props) { ); } - sidebarData.forEach(sidebarItem => - mutateSidebarCollapsingState(sidebarItem, location), - ); + if (sidebarCollapsible) { + sidebarData.forEach(sidebarItem => + mutateSidebarCollapsingState(sidebarItem, location), + ); + } return (
@@ -162,6 +171,7 @@ function DocSidebar(props) { onItemClick={() => { setShowResponsiveSidebar(false); }} + collapsible={sidebarCollapsible} /> ))} diff --git a/website/docs/advanced-plugins.md b/website/docs/advanced-plugins.md index 3491ae5a8105..4970f451df35 100644 --- a/website/docs/advanced-plugins.md +++ b/website/docs/advanced-plugins.md @@ -108,18 +108,19 @@ module.exports = { @@ -172,6 +173,11 @@ module.exports = { * Whether to display the last date the doc was updated. * / showLastUpdateTime: false, + /** + * For sites with a sizable amount of content, set collapsible to true. + * Expand/collapse the links and subcategories under categories. + * / + sidebarCollapsible: true, }, ], ], diff --git a/website/docs/migrating-from-v1-to-v2.md b/website/docs/migrating-from-v1-to-v2.md index 5ebaee071531..08c19204312f 100644 --- a/website/docs/migrating-from-v1-to-v2.md +++ b/website/docs/migrating-from-v1-to-v2.md @@ -290,6 +290,8 @@ module.exports = { showLastUpdateAuthor: true, // Equivalent to `enableUpdateTime`. showLastUpdateTime: true, + // Equivalent to `docsSideNavCollapsible`. + sidebarCollapsible: true, }, ... }, From e59053ddfd4f8f669cc3f71de654d0132e4b8e8f Mon Sep 17 00:00:00 2001 From: Alexey Pyltsyn Date: Wed, 23 Oct 2019 23:36:49 +0300 Subject: [PATCH 2/8] Fix tests --- .../docusaurus-plugin-content-docs/src/__tests__/index.test.ts | 2 ++ 1 file changed, 2 insertions(+) diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/index.test.ts b/packages/docusaurus-plugin-content-docs/src/__tests__/index.test.ts index a338bed2aadb..5cfe1fcdf3b8 100644 --- a/packages/docusaurus-plugin-content-docs/src/__tests__/index.test.ts +++ b/packages/docusaurus-plugin-content-docs/src/__tests__/index.test.ts @@ -43,6 +43,7 @@ describe('loadDocs', () => { source: path.join('@site', pluginPath, 'hello.md'), title: 'Hello, World !', description: 'Hi, Endilie here :)', + sidebarCollapsible: true, }); expect(docsMetadata['foo/bar']).toEqual({ @@ -56,6 +57,7 @@ describe('loadDocs', () => { source: path.join('@site', pluginPath, 'foo', 'bar.md'), title: 'Bar', description: 'This is custom description', + sidebarCollapsible: true, }); }); }); From 320210e5d03834d9b63c76e1d4b06d7c3684ef4b Mon Sep 17 00:00:00 2001 From: Alexey Pyltsyn Date: Thu, 24 Oct 2019 14:02:17 +0300 Subject: [PATCH 3/8] Refactor: use themeConfig --- .../src/__tests__/index.test.ts | 2 -- packages/docusaurus-plugin-content-docs/src/index.ts | 5 ----- packages/docusaurus-plugin-content-docs/src/metadata.ts | 4 ---- packages/docusaurus-plugin-content-docs/src/types.ts | 5 +---- .../docusaurus-theme-classic/src/theme/DocPage/index.js | 7 ++++++- website/docs/advanced-plugins.md | 5 ----- website/docs/migrating-from-v1-to-v2.md | 4 +--- website/docusaurus.config.js | 1 + 8 files changed, 9 insertions(+), 24 deletions(-) diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/index.test.ts b/packages/docusaurus-plugin-content-docs/src/__tests__/index.test.ts index 5cfe1fcdf3b8..a338bed2aadb 100644 --- a/packages/docusaurus-plugin-content-docs/src/__tests__/index.test.ts +++ b/packages/docusaurus-plugin-content-docs/src/__tests__/index.test.ts @@ -43,7 +43,6 @@ describe('loadDocs', () => { source: path.join('@site', pluginPath, 'hello.md'), title: 'Hello, World !', description: 'Hi, Endilie here :)', - sidebarCollapsible: true, }); expect(docsMetadata['foo/bar']).toEqual({ @@ -57,7 +56,6 @@ describe('loadDocs', () => { source: path.join('@site', pluginPath, 'foo', 'bar.md'), title: 'Bar', description: 'This is custom description', - sidebarCollapsible: true, }); }); }); diff --git a/packages/docusaurus-plugin-content-docs/src/index.ts b/packages/docusaurus-plugin-content-docs/src/index.ts index 1568067fdf5b..3e958c56744f 100644 --- a/packages/docusaurus-plugin-content-docs/src/index.ts +++ b/packages/docusaurus-plugin-content-docs/src/index.ts @@ -44,7 +44,6 @@ const DEFAULT_OPTIONS: PluginOptions = { rehypePlugins: [], showLastUpdateTime: false, showLastUpdateAuthor: false, - sidebarCollapsible: true, }; export default function pluginContentDocs( @@ -77,7 +76,6 @@ export default function pluginContentDocs( editUrl, showLastUpdateAuthor, showLastUpdateTime, - sidebarCollapsible, } = options; const {siteConfig, siteDir} = context; const docsDir = contentPath; @@ -112,7 +110,6 @@ export default function pluginContentDocs( editUrl, showLastUpdateAuthor, showLastUpdateTime, - sidebarCollapsible, }); docsMetadataRaw[metadata.id] = metadata; @@ -208,7 +205,6 @@ export default function pluginContentDocs( docsSidebars, sourceToPermalink, permalinkToSidebar, - sidebarCollapsible, }; }, @@ -243,7 +239,6 @@ export default function pluginContentDocs( const docsBaseMetadata: DocsBaseMetadata = { docsSidebars: content.docsSidebars, permalinkToSidebar: content.permalinkToSidebar, - sidebarCollapsible: content.sidebarCollapsible, }; const docsBaseRoute = normalizeUrl([ diff --git a/packages/docusaurus-plugin-content-docs/src/metadata.ts b/packages/docusaurus-plugin-content-docs/src/metadata.ts index d6f52a3ae52d..e1bfb64f4c63 100644 --- a/packages/docusaurus-plugin-content-docs/src/metadata.ts +++ b/packages/docusaurus-plugin-content-docs/src/metadata.ts @@ -23,7 +23,6 @@ type Args = { editUrl?: string; showLastUpdateAuthor?: boolean; showLastUpdateTime?: boolean; - sidebarCollapsible?: boolean; }; export default async function processMetadata({ @@ -36,7 +35,6 @@ export default async function processMetadata({ editUrl, showLastUpdateAuthor, showLastUpdateTime, - sidebarCollapsible, }: Args): Promise { const filePath = path.join(docsDir, source); @@ -132,7 +130,5 @@ export default async function processMetadata({ } } - metadata.sidebarCollapsible = sidebarCollapsible; - return metadata as MetadataRaw; } diff --git a/packages/docusaurus-plugin-content-docs/src/types.ts b/packages/docusaurus-plugin-content-docs/src/types.ts index 9b3408c2d924..faaf3fb7be0c 100644 --- a/packages/docusaurus-plugin-content-docs/src/types.ts +++ b/packages/docusaurus-plugin-content-docs/src/types.ts @@ -17,7 +17,6 @@ export interface PluginOptions { editUrl?: string; showLastUpdateTime?: boolean; showLastUpdateAuthor?: boolean; - sidebarCollapsible?: boolean; } export type SidebarItemDoc = { @@ -96,7 +95,6 @@ export interface MetadataRaw extends OrderMetadata { lastUpdatedAt?: number; lastUpdatedBy?: string; hide_title?: boolean; - sidebarCollapsible?: boolean; [key: string]: any; } @@ -128,10 +126,9 @@ export interface LoadedContent { docsSidebars: Sidebar; sourceToPermalink: SourceToPermalink; permalinkToSidebar: PermalinkToSidebar; - sidebarCollapsible?: boolean; } export type DocsBaseMetadata = Pick< LoadedContent, - 'docsSidebars' | 'permalinkToSidebar' | 'sidebarCollapsible' + 'docsSidebars' | 'permalinkToSidebar' >; diff --git a/packages/docusaurus-theme-classic/src/theme/DocPage/index.js b/packages/docusaurus-theme-classic/src/theme/DocPage/index.js index 90de135311f5..a45e40bb3949 100644 --- a/packages/docusaurus-theme-classic/src/theme/DocPage/index.js +++ b/packages/docusaurus-theme-classic/src/theme/DocPage/index.js @@ -9,6 +9,7 @@ import React from 'react'; import {MDXProvider} from '@mdx-js/react'; import renderRoutes from '@docusaurus/renderRoutes'; +import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; import Layout from '@theme/Layout'; import DocSidebar from '@theme/DocSidebar'; import MDXComponents from '@theme/MDXComponents'; @@ -17,8 +18,12 @@ import styles from './styles.module.css'; function DocPage(props) { const {route, docsMetadata, location} = props; - const {permalinkToSidebar, docsSidebars, sidebarCollapsible} = docsMetadata; + const {permalinkToSidebar, docsSidebars} = docsMetadata; const sidebar = permalinkToSidebar[location.pathname.replace(/\/$/, '')]; + const {siteConfig = {}} = useDocusaurusContext(); + const { + themeConfig: {sidebarCollapsible = true}, + } = siteConfig; return ( diff --git a/website/docs/advanced-plugins.md b/website/docs/advanced-plugins.md index 4970f451df35..b25123341b79 100644 --- a/website/docs/advanced-plugins.md +++ b/website/docs/advanced-plugins.md @@ -173,11 +173,6 @@ module.exports = { * Whether to display the last date the doc was updated. * / showLastUpdateTime: false, - /** - * For sites with a sizable amount of content, set collapsible to true. - * Expand/collapse the links and subcategories under categories. - * / - sidebarCollapsible: true, }, ], ], diff --git a/website/docs/migrating-from-v1-to-v2.md b/website/docs/migrating-from-v1-to-v2.md index 08c19204312f..990b8a06bf6f 100644 --- a/website/docs/migrating-from-v1-to-v2.md +++ b/website/docs/migrating-from-v1-to-v2.md @@ -290,8 +290,6 @@ module.exports = { showLastUpdateAuthor: true, // Equivalent to `enableUpdateTime`. showLastUpdateTime: true, - // Equivalent to `docsSideNavCollapsible`. - sidebarCollapsible: true, }, ... }, @@ -335,7 +333,7 @@ The following fields are all deprecated, you may remove from your configuration - `defaultVersionShown` - Versioning is not ported yet. You'd be unable to migration to Docusaurus 2 if you are using versioning. Stay tuned. - `disableHeaderTitle` - `disableTitleTagline` -- `docsSideNavCollapsible` - This is turned on by default now. +- `docsSideNavCollapsible` renamed to `sidebarCollapsible`, and this is turned on by default now. ??? - `facebookAppId` - `facebookComments` - `facebookPixelId` diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 741aa0ebdb80..b8ee148d270e 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -48,6 +48,7 @@ module.exports = { ], ], themeConfig: { + sidebarCollapsible: false, image: 'img/docusaurus.png', gtag: { trackingID: 'UA-141789564-1', From 816a0bd59ac0909883993f5eb3dba2dc9d4d6296 Mon Sep 17 00:00:00 2001 From: Alexey Pyltsyn Date: Thu, 24 Oct 2019 14:11:11 +0300 Subject: [PATCH 4/8] Improve docs --- website/docs/migrating-from-v1-to-v2.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/website/docs/migrating-from-v1-to-v2.md b/website/docs/migrating-from-v1-to-v2.md index 990b8a06bf6f..0685b3cf071e 100644 --- a/website/docs/migrating-from-v1-to-v2.md +++ b/website/docs/migrating-from-v1-to-v2.md @@ -161,7 +161,7 @@ Infima uses 7 shades of each color. We recommend using [ColorBox](https://www.co } ``` -#### `footerIcon`, `copyright`, `ogImage`, `twitterImage` +#### `footerIcon`, `copyright`, `ogImage`, `twitterImage`, 'docsSideNavCollapsible' Site meta info such as assets, SEO, copyright info are now handled by themes. To customize them, use the `themeConfig` field in your `docusaurus.config.js`: @@ -177,6 +177,8 @@ module.exports = { copyright: `Copyright © ${new Date().getFullYear()} Facebook, Inc.`, }, image: 'img/docusaurus.png', + // Equivalent to `docsSideNavCollapsible` + sidebarCollapsible: false, ... }, }; @@ -333,7 +335,7 @@ The following fields are all deprecated, you may remove from your configuration - `defaultVersionShown` - Versioning is not ported yet. You'd be unable to migration to Docusaurus 2 if you are using versioning. Stay tuned. - `disableHeaderTitle` - `disableTitleTagline` -- `docsSideNavCollapsible` renamed to `sidebarCollapsible`, and this is turned on by default now. ??? +- `docsSideNavCollapsible` is available at `themeConfig.sidebarCollapsible`, and this is turned on by default now. - `facebookAppId` - `facebookComments` - `facebookPixelId` From e2a65e95c71eb247dc4b2fa9395e206da3b6cd48 Mon Sep 17 00:00:00 2001 From: Alexey Pyltsyn Date: Thu, 24 Oct 2019 14:15:55 +0300 Subject: [PATCH 5/8] Revert unnecessary changes --- .../src/index.ts | 1 - website/docs/advanced-plugins.md | 24 +++++++++---------- website/docusaurus.config.js | 1 - 3 files changed, 11 insertions(+), 15 deletions(-) diff --git a/packages/docusaurus-plugin-content-docs/src/index.ts b/packages/docusaurus-plugin-content-docs/src/index.ts index 3e958c56744f..c40852153818 100644 --- a/packages/docusaurus-plugin-content-docs/src/index.ts +++ b/packages/docusaurus-plugin-content-docs/src/index.ts @@ -111,7 +111,6 @@ export default function pluginContentDocs( showLastUpdateAuthor, showLastUpdateTime, }); - docsMetadataRaw[metadata.id] = metadata; }), ); diff --git a/website/docs/advanced-plugins.md b/website/docs/advanced-plugins.md index b25123341b79..6ba938a00794 100644 --- a/website/docs/advanced-plugins.md +++ b/website/docs/advanced-plugins.md @@ -108,19 +108,17 @@ module.exports = { diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index b8ee148d270e..741aa0ebdb80 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -48,7 +48,6 @@ module.exports = { ], ], themeConfig: { - sidebarCollapsible: false, image: 'img/docusaurus.png', gtag: { trackingID: 'UA-141789564-1', From a7bc998f3cbb0a0441b15daab890106005e00425 Mon Sep 17 00:00:00 2001 From: Alexey Pyltsyn Date: Thu, 24 Oct 2019 14:24:56 +0300 Subject: [PATCH 6/8] Refactor: better consistency --- .../docusaurus-theme-classic/src/theme/DocPage/index.js | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/packages/docusaurus-theme-classic/src/theme/DocPage/index.js b/packages/docusaurus-theme-classic/src/theme/DocPage/index.js index a45e40bb3949..5765d718d5de 100644 --- a/packages/docusaurus-theme-classic/src/theme/DocPage/index.js +++ b/packages/docusaurus-theme-classic/src/theme/DocPage/index.js @@ -8,22 +8,21 @@ import React from 'react'; import {MDXProvider} from '@mdx-js/react'; +import siteConfig from '@generated/docusaurus.config'; import renderRoutes from '@docusaurus/renderRoutes'; -import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; import Layout from '@theme/Layout'; import DocSidebar from '@theme/DocSidebar'; import MDXComponents from '@theme/MDXComponents'; import styles from './styles.module.css'; +const {themeConfig} = siteConfig; + function DocPage(props) { const {route, docsMetadata, location} = props; const {permalinkToSidebar, docsSidebars} = docsMetadata; const sidebar = permalinkToSidebar[location.pathname.replace(/\/$/, '')]; - const {siteConfig = {}} = useDocusaurusContext(); - const { - themeConfig: {sidebarCollapsible = true}, - } = siteConfig; + const {sidebarCollapsible = true} = themeConfig; return ( From 35335494847a1b001f9bdc74696095620d78ddf1 Mon Sep 17 00:00:00 2001 From: Alexey Pyltsyn Date: Thu, 24 Oct 2019 14:27:48 +0300 Subject: [PATCH 7/8] Revert extra change --- website/docs/advanced-plugins.md | 1 + 1 file changed, 1 insertion(+) diff --git a/website/docs/advanced-plugins.md b/website/docs/advanced-plugins.md index 6ba938a00794..3491ae5a8105 100644 --- a/website/docs/advanced-plugins.md +++ b/website/docs/advanced-plugins.md @@ -117,6 +117,7 @@ module.exports = { | `blogListComponent` | `'@theme/BlogListPage'` | Theme component used for the blog listing page | | `blogPostComponent` | `'@theme/BlogPostPage'` | Theme component used for the blog post page | | `blogTagsListComponent` | `'@theme/BlogTagsListPage'` | Theme component used for the blog tags list page | +| `blogTagsPostsComponent` | `'@theme/BlogTagsPostsPage'` | Theme component used for the blog tags post page | | `remarkPlugins` | `[]` | Plugins for remark | | `rehypePlugins` | `[]` | Plugins for rehype | commenting out because charts look less direct than code example From 072d8c64fddaec4d093e772017bb1d29f2ca7f24 Mon Sep 17 00:00:00 2001 From: Alexey Pyltsyn Date: Thu, 24 Oct 2019 16:56:52 +0300 Subject: [PATCH 8/8] Refactor: use useDocusaurusContext to get config value --- packages/docusaurus-theme-classic/src/theme/DocPage/index.js | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/packages/docusaurus-theme-classic/src/theme/DocPage/index.js b/packages/docusaurus-theme-classic/src/theme/DocPage/index.js index 5765d718d5de..85f9b0dc3e1c 100644 --- a/packages/docusaurus-theme-classic/src/theme/DocPage/index.js +++ b/packages/docusaurus-theme-classic/src/theme/DocPage/index.js @@ -8,7 +8,7 @@ import React from 'react'; import {MDXProvider} from '@mdx-js/react'; -import siteConfig from '@generated/docusaurus.config'; +import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; import renderRoutes from '@docusaurus/renderRoutes'; import Layout from '@theme/Layout'; import DocSidebar from '@theme/DocSidebar'; @@ -16,12 +16,11 @@ import MDXComponents from '@theme/MDXComponents'; import styles from './styles.module.css'; -const {themeConfig} = siteConfig; - function DocPage(props) { const {route, docsMetadata, location} = props; const {permalinkToSidebar, docsSidebars} = docsMetadata; const sidebar = permalinkToSidebar[location.pathname.replace(/\/$/, '')]; + const {siteConfig: {themeConfig = {}} = {}} = useDocusaurusContext(); const {sidebarCollapsible = true} = themeConfig; return (