diff --git a/packages/docusaurus-plugin-content-docs/package.json b/packages/docusaurus-plugin-content-docs-legacy/package.json similarity index 80% rename from packages/docusaurus-plugin-content-docs/package.json rename to packages/docusaurus-plugin-content-docs-legacy/package.json index 63bd8db8c7..2e0a450809 100644 --- a/packages/docusaurus-plugin-content-docs/package.json +++ b/packages/docusaurus-plugin-content-docs-legacy/package.json @@ -1,7 +1,7 @@ { - "name": "@docusaurus/plugin-content-docs", + "name": "@docusaurus/plugin-content-docs-legacy", "version": "2.0.0-alpha.19", - "description": "Documentation plugin for Docusaurus", + "description": "Documentation plugin for legacy v1 Docusaurus docs", "main": "src/index.js", "publishConfig": { "access": "public" diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/website/bad-sidebars.json b/packages/docusaurus-plugin-content-docs-legacy/src/__tests__/__fixtures__/website/bad-sidebars.json similarity index 100% rename from packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/website/bad-sidebars.json rename to packages/docusaurus-plugin-content-docs-legacy/src/__tests__/__fixtures__/website/bad-sidebars.json diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/website/docs/foo/bar.md b/packages/docusaurus-plugin-content-docs-legacy/src/__tests__/__fixtures__/website/docs/foo/bar.md similarity index 100% rename from packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/website/docs/foo/bar.md rename to packages/docusaurus-plugin-content-docs-legacy/src/__tests__/__fixtures__/website/docs/foo/bar.md diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/website/docs/foo/baz.md b/packages/docusaurus-plugin-content-docs-legacy/src/__tests__/__fixtures__/website/docs/foo/baz.md similarity index 100% rename from packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/website/docs/foo/baz.md rename to packages/docusaurus-plugin-content-docs-legacy/src/__tests__/__fixtures__/website/docs/foo/baz.md diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/website/docs/hello.md b/packages/docusaurus-plugin-content-docs-legacy/src/__tests__/__fixtures__/website/docs/hello.md similarity index 100% rename from packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/website/docs/hello.md rename to packages/docusaurus-plugin-content-docs-legacy/src/__tests__/__fixtures__/website/docs/hello.md diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/website/docs/permalink.md b/packages/docusaurus-plugin-content-docs-legacy/src/__tests__/__fixtures__/website/docs/permalink.md similarity index 100% rename from packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/website/docs/permalink.md rename to packages/docusaurus-plugin-content-docs-legacy/src/__tests__/__fixtures__/website/docs/permalink.md diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/website/sidebars.json b/packages/docusaurus-plugin-content-docs-legacy/src/__tests__/__fixtures__/website/sidebars.json similarity index 100% rename from packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/website/sidebars.json rename to packages/docusaurus-plugin-content-docs-legacy/src/__tests__/__fixtures__/website/sidebars.json diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/sidebars.test.js.snap b/packages/docusaurus-plugin-content-docs-legacy/src/__tests__/__snapshots__/sidebars.test.js.snap similarity index 100% rename from packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/sidebars.test.js.snap rename to packages/docusaurus-plugin-content-docs-legacy/src/__tests__/__snapshots__/sidebars.test.js.snap diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/index.test.js b/packages/docusaurus-plugin-content-docs-legacy/src/__tests__/index.test.js similarity index 100% rename from packages/docusaurus-plugin-content-docs/src/__tests__/index.test.js rename to packages/docusaurus-plugin-content-docs-legacy/src/__tests__/index.test.js diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/metadata.test.js b/packages/docusaurus-plugin-content-docs-legacy/src/__tests__/metadata.test.js similarity index 100% rename from packages/docusaurus-plugin-content-docs/src/__tests__/metadata.test.js rename to packages/docusaurus-plugin-content-docs-legacy/src/__tests__/metadata.test.js diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/order.test.js b/packages/docusaurus-plugin-content-docs-legacy/src/__tests__/order.test.js similarity index 100% rename from packages/docusaurus-plugin-content-docs/src/__tests__/order.test.js rename to packages/docusaurus-plugin-content-docs-legacy/src/__tests__/order.test.js diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/sidebars.test.js b/packages/docusaurus-plugin-content-docs-legacy/src/__tests__/sidebars.test.js similarity index 100% rename from packages/docusaurus-plugin-content-docs/src/__tests__/sidebars.test.js rename to packages/docusaurus-plugin-content-docs-legacy/src/__tests__/sidebars.test.js diff --git a/packages/docusaurus-plugin-content-docs/src/index.js b/packages/docusaurus-plugin-content-docs-legacy/src/index.js similarity index 98% rename from packages/docusaurus-plugin-content-docs/src/index.js rename to packages/docusaurus-plugin-content-docs-legacy/src/index.js index 2f99812cf4..f13731ba93 100644 --- a/packages/docusaurus-plugin-content-docs/src/index.js +++ b/packages/docusaurus-plugin-content-docs-legacy/src/index.js @@ -21,8 +21,8 @@ const DEFAULT_OPTIONS = { // TODO: Change format to array. sidebarPath: '', // Path to sidebar configuration for showing a list of markdown pages. // TODO: Settle themeing. - docLayoutComponent: '@theme/DocPage', - docItemComponent: '@theme/DocItem', + docLayoutComponent: '@theme/DocLegacyPage', + docItemComponent: '@theme/DocLegacyItem', remarkPlugins: [], rehypePlugins: [], }; diff --git a/packages/docusaurus-plugin-content-docs/src/markdown/index.js b/packages/docusaurus-plugin-content-docs-legacy/src/markdown/index.js similarity index 100% rename from packages/docusaurus-plugin-content-docs/src/markdown/index.js rename to packages/docusaurus-plugin-content-docs-legacy/src/markdown/index.js diff --git a/packages/docusaurus-plugin-content-docs/src/metadata.js b/packages/docusaurus-plugin-content-docs-legacy/src/metadata.js similarity index 100% rename from packages/docusaurus-plugin-content-docs/src/metadata.js rename to packages/docusaurus-plugin-content-docs-legacy/src/metadata.js diff --git a/packages/docusaurus-plugin-content-docs/src/order.js b/packages/docusaurus-plugin-content-docs-legacy/src/order.js similarity index 100% rename from packages/docusaurus-plugin-content-docs/src/order.js rename to packages/docusaurus-plugin-content-docs-legacy/src/order.js diff --git a/packages/docusaurus-plugin-content-docs/src/sidebars.js b/packages/docusaurus-plugin-content-docs-legacy/src/sidebars.js similarity index 100% rename from packages/docusaurus-plugin-content-docs/src/sidebars.js rename to packages/docusaurus-plugin-content-docs-legacy/src/sidebars.js diff --git a/packages/docusaurus-preset-classic/package.json b/packages/docusaurus-preset-classic/package.json index 2192f8ddf7..c388b5819b 100644 --- a/packages/docusaurus-preset-classic/package.json +++ b/packages/docusaurus-preset-classic/package.json @@ -9,7 +9,7 @@ "license": "MIT", "dependencies": { "@docusaurus/plugin-content-blog": "^2.0.0-alpha.19", - "@docusaurus/plugin-content-docs": "^2.0.0-alpha.19", + "@docusaurus/plugin-content-docs-legacy": "^2.0.0-alpha.19", "@docusaurus/plugin-content-pages": "^2.0.0-alpha.19", "@docusaurus/plugin-sitemap": "^2.0.0-alpha.19", "@docusaurus/theme-classic": "^2.0.0-alpha.19", diff --git a/packages/docusaurus-preset-classic/src/index.js b/packages/docusaurus-preset-classic/src/index.js index 1690e4bc30..69558fd8f7 100644 --- a/packages/docusaurus-preset-classic/src/index.js +++ b/packages/docusaurus-preset-classic/src/index.js @@ -17,7 +17,7 @@ module.exports = function preset(context, opts = {}) { algolia && '@docusaurus/theme-search-algolia', ], plugins: [ - ['@docusaurus/plugin-content-docs', opts.docs], + ['@docusaurus/plugin-content-docs-legacy', opts.docs], ['@docusaurus/plugin-content-blog', opts.blog], ['@docusaurus/plugin-content-pages', opts.pages], googleAnalytics && '@docusaurus/plugin-google-analytics', diff --git a/packages/docusaurus-theme-classic/src/theme/DocItem/index.js b/packages/docusaurus-theme-classic/src/theme/DocLegacyItem/index.js similarity index 86% rename from packages/docusaurus-theme-classic/src/theme/DocItem/index.js rename to packages/docusaurus-theme-classic/src/theme/DocLegacyItem/index.js index b7027df178..266152ca57 100644 --- a/packages/docusaurus-theme-classic/src/theme/DocItem/index.js +++ b/packages/docusaurus-theme-classic/src/theme/DocLegacyItem/index.js @@ -8,7 +8,7 @@ import React from 'react'; import Head from '@docusaurus/Head'; -import DocPaginator from '@theme/DocPaginator'; +import DocLegacyPaginator from '@theme/DocLegacyPaginator'; import styles from './styles.module.css'; @@ -28,7 +28,7 @@ function Headings({headings, isChild}) { ); } -function DocItem(props) { +function DocLegacyItem(props) { const {metadata, content: DocContent, docsMetadata} = props; return ( @@ -49,7 +49,10 @@ function DocItem(props) {
- +
@@ -66,4 +69,4 @@ function DocItem(props) { ); } -export default DocItem; +export default DocLegacyItem; diff --git a/packages/docusaurus-theme-classic/src/theme/DocItem/styles.module.css b/packages/docusaurus-theme-classic/src/theme/DocLegacyItem/styles.module.css similarity index 100% rename from packages/docusaurus-theme-classic/src/theme/DocItem/styles.module.css rename to packages/docusaurus-theme-classic/src/theme/DocLegacyItem/styles.module.css diff --git a/packages/docusaurus-theme-classic/src/theme/DocPage/index.js b/packages/docusaurus-theme-classic/src/theme/DocLegacyPage/index.js similarity index 85% rename from packages/docusaurus-theme-classic/src/theme/DocPage/index.js rename to packages/docusaurus-theme-classic/src/theme/DocLegacyPage/index.js index 887b91bf32..ac17525817 100644 --- a/packages/docusaurus-theme-classic/src/theme/DocPage/index.js +++ b/packages/docusaurus-theme-classic/src/theme/DocLegacyPage/index.js @@ -10,10 +10,10 @@ import {MDXProvider} from '@mdx-js/react'; import renderRoutes from '@docusaurus/renderRoutes'; import Layout from '@theme/Layout'; -import DocSidebar from '@theme/DocSidebar'; +import DocLegacySidebar from '@theme/DocLegacySidebar'; import MDXComponents from '@theme/MDXComponents'; -function DocPage(props) { +function DocLegacyPage(props) { const {route, docsMetadata, location} = props; const {permalinkToId} = docsMetadata; const id = @@ -27,7 +27,7 @@ function DocPage(props) {
- +
@@ -40,4 +40,4 @@ function DocPage(props) { ); } -export default DocPage; +export default DocLegacyPage; diff --git a/packages/docusaurus-theme-classic/src/theme/DocPaginator/index.js b/packages/docusaurus-theme-classic/src/theme/DocLegacyPaginator/index.js similarity index 94% rename from packages/docusaurus-theme-classic/src/theme/DocPaginator/index.js rename to packages/docusaurus-theme-classic/src/theme/DocLegacyPaginator/index.js index cb23e79bd7..6f616b06e9 100644 --- a/packages/docusaurus-theme-classic/src/theme/DocPaginator/index.js +++ b/packages/docusaurus-theme-classic/src/theme/DocLegacyPaginator/index.js @@ -8,7 +8,7 @@ import React from 'react'; import Link from '@docusaurus/Link'; -function DocPaginator(props) { +function DocLegacyPaginator(props) { const { docsMetadata: {docs}, metadata, @@ -44,4 +44,4 @@ function DocPaginator(props) { ); } -export default DocPaginator; +export default DocLegacyPaginator; diff --git a/packages/docusaurus-theme-classic/src/theme/DocSidebar/index.js b/packages/docusaurus-theme-classic/src/theme/DocLegacySidebar/index.js similarity index 96% rename from packages/docusaurus-theme-classic/src/theme/DocSidebar/index.js rename to packages/docusaurus-theme-classic/src/theme/DocLegacySidebar/index.js index f15e008ed4..3b9cc395de 100644 --- a/packages/docusaurus-theme-classic/src/theme/DocSidebar/index.js +++ b/packages/docusaurus-theme-classic/src/theme/DocLegacySidebar/index.js @@ -8,13 +8,13 @@ import React, {useState} from 'react'; import classnames from 'classnames'; -import Link from '@docusaurus/Link'; // eslint-disable-line +import Link from '@docusaurus/Link'; import styles from './styles.module.css'; const MOBILE_TOGGLE_SIZE = 24; -function DocSidebar(props) { +function DocLegacySidebar(props) { const [showResponsiveSidebar, setShowResponsiveSidebar] = useState(false); const {docsMetadata, sidebar} = props; @@ -127,4 +127,4 @@ function DocSidebar(props) { ); } -export default DocSidebar; +export default DocLegacySidebar; diff --git a/packages/docusaurus-theme-classic/src/theme/DocSidebar/styles.module.css b/packages/docusaurus-theme-classic/src/theme/DocLegacySidebar/styles.module.css similarity index 100% rename from packages/docusaurus-theme-classic/src/theme/DocSidebar/styles.module.css rename to packages/docusaurus-theme-classic/src/theme/DocLegacySidebar/styles.module.css diff --git a/packages/docusaurus/src/server/__tests__/__fixtures__/custom-site/docusaurus.config.js b/packages/docusaurus/src/server/__tests__/__fixtures__/custom-site/docusaurus.config.js index 07f979ed05..55dc927146 100644 --- a/packages/docusaurus/src/server/__tests__/__fixtures__/custom-site/docusaurus.config.js +++ b/packages/docusaurus/src/server/__tests__/__fixtures__/custom-site/docusaurus.config.js @@ -15,7 +15,7 @@ module.exports = { favicon: 'img/docusaurus.ico', plugins: [ [ - '@docusaurus/plugin-content-docs', + '@docusaurus/plugin-content-docs-legacy', { path: '../docs', sidebarPath: require.resolve('./sidebars.js'), diff --git a/packages/docusaurus/src/server/__tests__/__fixtures__/simple-site/docusaurus.config.js b/packages/docusaurus/src/server/__tests__/__fixtures__/simple-site/docusaurus.config.js index 0ead074a11..409be12eb5 100644 --- a/packages/docusaurus/src/server/__tests__/__fixtures__/simple-site/docusaurus.config.js +++ b/packages/docusaurus/src/server/__tests__/__fixtures__/simple-site/docusaurus.config.js @@ -15,7 +15,7 @@ module.exports = { favicon: 'img/docusaurus.ico', plugins: [ [ - '@docusaurus/plugin-content-docs', + '@docusaurus/plugin-content-docs-legacy', { path: '../docs', sidebarPath: require.resolve('./sidebars.js'),