From 528bd7f280af61ce24972e3f09aee48ca47db5dd Mon Sep 17 00:00:00 2001 From: Endi Date: Sun, 28 Apr 2019 23:43:40 +0700 Subject: [PATCH] chore(v2): add tbd v2 docs (#1408) * docs(v2): docusaurus 2 own docs * misc(v2): try to get multiple sidebar working * misc(v2): tweak CSS * fix(v2): fix conflicting docsMetadata --- .../src/index.js | 8 ++++-- .../docusaurus/lib/default-theme/Doc/index.js | 14 ++++++----- .../lib/default-theme/DocBody/index.js | 6 +++++ website/docs/introduction.md | 15 +++++++++++ website/docusaurus.config.js | 15 +++++++++-- website/sidebars-legacy.json | 25 +++++++++++++++++++ website/sidebars.json | 19 +++----------- 7 files changed, 76 insertions(+), 26 deletions(-) create mode 100644 website/docs/introduction.md create mode 100644 website/sidebars-legacy.json diff --git a/packages/docusaurus-plugin-content-docs/src/index.js b/packages/docusaurus-plugin-content-docs/src/index.js index 9f5adbc21b..a0a04e0cd3 100644 --- a/packages/docusaurus-plugin-content-docs/src/index.js +++ b/packages/docusaurus-plugin-content-docs/src/index.js @@ -234,13 +234,17 @@ class DocusaurusPluginContentDocs { }), ); + const docsBaseRoute = normalizeUrl([ + this.context.siteConfig.baseUrl, + routeBasePath, + ]); const docsMetadataPath = await createData( - `docsMetadata.json`, + `${docuHash(docsBaseRoute)}.json`, JSON.stringify(content, null, 2), ); addRoute({ - path: normalizeUrl([this.context.siteConfig.baseUrl, routeBasePath]), + path: docsBaseRoute, component: docLayoutComponent, routes, modules: { diff --git a/packages/docusaurus/lib/default-theme/Doc/index.js b/packages/docusaurus/lib/default-theme/Doc/index.js index 8df92233fe..f50d9da10c 100644 --- a/packages/docusaurus/lib/default-theme/Doc/index.js +++ b/packages/docusaurus/lib/default-theme/Doc/index.js @@ -26,12 +26,14 @@ function Doc(props) { {siteConfig.title} {favicon && } -
-
- -
-
- {renderRoutes(route.routes, {docsMetadata})} +
+
+
+ +
+
+ {renderRoutes(route.routes, {docsMetadata})} +
diff --git a/packages/docusaurus/lib/default-theme/DocBody/index.js b/packages/docusaurus/lib/default-theme/DocBody/index.js index 4439f22a69..786b712a59 100644 --- a/packages/docusaurus/lib/default-theme/DocBody/index.js +++ b/packages/docusaurus/lib/default-theme/DocBody/index.js @@ -45,6 +45,12 @@ function DocBody(props) {
+ {/* TODO: remove this in the future */} +
+ Docusaurus 2 is still work in progress. Do not + use it in production yet! +
+

{metadata.title}

diff --git a/website/docs/introduction.md b/website/docs/introduction.md new file mode 100644 index 0000000000..604d9ec5ac --- /dev/null +++ b/website/docs/introduction.md @@ -0,0 +1,15 @@ +--- +id: introduction +title: Introduction +--- + + +![Introducing Slash](/img/slash-introducing.svg) + +Docusaurus is a **painless static site generator** powered by React. + + +## Installation + +TODO + diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 5d71dfc694..ac63f09151 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -13,7 +13,8 @@ module.exports = { baseUrl: '/', url: 'https://docusaurus-2.netlify.com', headerLinks: [ - {url: 'docs/installation', label: 'Docs'}, + {url: 'docs-legacy/installation', label: 'Docs V1'}, + {url: 'docs/introduction', label: 'Docs'}, {url: 'blog', label: 'Blog'}, {url: 'feedback/', label: 'Feedback'}, ], @@ -29,7 +30,7 @@ module.exports = { '@docusaurus/preset-classic', { docs: { - path: '../docs', + path: 'docs', sidebarPath: require.resolve('./sidebars.json'), }, blog: { @@ -38,4 +39,14 @@ module.exports = { }, ], ], + plugins: [ + { + name: '@docusaurus/plugin-content-docs', + options: { + path: '../docs', + routeBasePath: 'docs-legacy', + sidebarPath: require.resolve('./sidebars-legacy.json'), + }, + }, + ], }; diff --git a/website/sidebars-legacy.json b/website/sidebars-legacy.json new file mode 100644 index 0000000000..632546c139 --- /dev/null +++ b/website/sidebars-legacy.json @@ -0,0 +1,25 @@ +{ + "docs-legacy": { + "Getting Started": [ + "installation", + "site-preparation", + "site-creation", + "publishing", + "docker" + ], + "Guides": [ + "adding-blog", + "custom-pages", + "search", + "navigation", + "translation", + "versioning" + ], + "API": [ + "commands", + "doc-markdown", + "api-pages", + "site-config" + ] + } +} diff --git a/website/sidebars.json b/website/sidebars.json index da7246cf9a..8ba4ef3427 100644 --- a/website/sidebars.json +++ b/website/sidebars.json @@ -1,20 +1,7 @@ { "docs": { - "Getting Started": [ - "installation", - "site-preparation", - "site-creation", - "publishing", - "docker" - ], - "Guides": [ - "adding-blog", - "custom-pages", - "search", - "navigation", - "translation", - "versioning" - ], - "API": ["commands", "doc-markdown", "api-pages", "site-config"] + "Quick Start": [ + "introduction" + ] } }