diff --git a/.eslintignore b/.eslintignore index c47f508ac6..bda9362a87 100644 --- a/.eslintignore +++ b/.eslintignore @@ -14,5 +14,5 @@ packages/docusaurus-utils/lib/ packages/docusaurus/lib/ packages/docusaurus-init/lib/ packages/docusaurus-plugin-content-blog/lib/ -packages/docusaurus-plugin-content-docs-legacy/lib/ +packages/docusaurus-plugin-content-docs/lib/ packages/docusaurus-plugin-content-pages/lib/ diff --git a/.gitignore b/.gitignore index 633f1d470f..929727c275 100644 --- a/.gitignore +++ b/.gitignore @@ -16,5 +16,5 @@ packages/docusaurus-utils/lib/ packages/docusaurus/lib/ packages/docusaurus-init/lib/ packages/docusaurus-plugin-content-blog/lib/ -packages/docusaurus-plugin-content-docs-legacy/lib/ +packages/docusaurus-plugin-content-docs/lib/ packages/docusaurus-plugin-content-pages/lib/ diff --git a/.prettierignore b/.prettierignore index 99d0e4c1f5..7499928e82 100644 --- a/.prettierignore +++ b/.prettierignore @@ -6,5 +6,5 @@ packages/docusaurus-utils/lib/ packages/docusaurus/lib/ packages/docusaurus-init/lib/ packages/docusaurus-plugin-content-blog/lib/ -packages/docusaurus-plugin-content-docs-legacy/lib/ +packages/docusaurus-plugin-content-docs/lib/ packages/docusaurus-plugin-content-pages/lib/ diff --git a/packages/docusaurus-plugin-content-docs-legacy/package.json b/packages/docusaurus-plugin-content-docs/package.json similarity index 83% rename from packages/docusaurus-plugin-content-docs-legacy/package.json rename to packages/docusaurus-plugin-content-docs/package.json index a83ead3970..cb5b3d44b3 100644 --- a/packages/docusaurus-plugin-content-docs-legacy/package.json +++ b/packages/docusaurus-plugin-content-docs/package.json @@ -1,7 +1,7 @@ { - "name": "@docusaurus/plugin-content-docs-legacy", + "name": "@docusaurus/plugin-content-docs", "version": "2.0.0-alpha.25", - "description": "Documentation plugin for legacy v1 Docusaurus docs", + "description": "Docs content plugin for Docusaurus", "main": "lib/index.js", "scripts": { "tsc": "tsc" diff --git a/packages/docusaurus-plugin-content-docs-legacy/src/__tests__/__fixtures__/website/bad-sidebars.json b/packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/website/bad-sidebars.json similarity index 100% rename from packages/docusaurus-plugin-content-docs-legacy/src/__tests__/__fixtures__/website/bad-sidebars.json rename to packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/website/bad-sidebars.json diff --git a/packages/docusaurus-plugin-content-docs-legacy/src/__tests__/__fixtures__/website/docs/foo/bar.md b/packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/website/docs/foo/bar.md similarity index 100% rename from packages/docusaurus-plugin-content-docs-legacy/src/__tests__/__fixtures__/website/docs/foo/bar.md rename to packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/website/docs/foo/bar.md diff --git a/packages/docusaurus-plugin-content-docs-legacy/src/__tests__/__fixtures__/website/docs/foo/baz.md b/packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/website/docs/foo/baz.md similarity index 100% rename from packages/docusaurus-plugin-content-docs-legacy/src/__tests__/__fixtures__/website/docs/foo/baz.md rename to packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/website/docs/foo/baz.md diff --git a/packages/docusaurus-plugin-content-docs-legacy/src/__tests__/__fixtures__/website/docs/hello.md b/packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/website/docs/hello.md similarity index 100% rename from packages/docusaurus-plugin-content-docs-legacy/src/__tests__/__fixtures__/website/docs/hello.md rename to packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/website/docs/hello.md diff --git a/packages/docusaurus-plugin-content-docs-legacy/src/__tests__/__fixtures__/website/docs/permalink.md b/packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/website/docs/permalink.md similarity index 100% rename from packages/docusaurus-plugin-content-docs-legacy/src/__tests__/__fixtures__/website/docs/permalink.md rename to packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/website/docs/permalink.md diff --git a/packages/docusaurus-plugin-content-docs-legacy/src/__tests__/__fixtures__/website/sidebars-category.js b/packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/website/sidebars-category.js similarity index 100% rename from packages/docusaurus-plugin-content-docs-legacy/src/__tests__/__fixtures__/website/sidebars-category.js rename to packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/website/sidebars-category.js diff --git a/packages/docusaurus-plugin-content-docs-legacy/src/__tests__/__fixtures__/website/sidebars.json b/packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/website/sidebars.json similarity index 100% rename from packages/docusaurus-plugin-content-docs-legacy/src/__tests__/__fixtures__/website/sidebars.json rename to packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/website/sidebars.json diff --git a/packages/docusaurus-plugin-content-docs-legacy/src/__tests__/__snapshots__/sidebars.test.ts.snap b/packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/sidebars.test.ts.snap similarity index 100% rename from packages/docusaurus-plugin-content-docs-legacy/src/__tests__/__snapshots__/sidebars.test.ts.snap rename to packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/sidebars.test.ts.snap diff --git a/packages/docusaurus-plugin-content-docs-legacy/src/__tests__/index.test.ts b/packages/docusaurus-plugin-content-docs/src/__tests__/index.test.ts similarity index 100% rename from packages/docusaurus-plugin-content-docs-legacy/src/__tests__/index.test.ts rename to packages/docusaurus-plugin-content-docs/src/__tests__/index.test.ts diff --git a/packages/docusaurus-plugin-content-docs-legacy/src/__tests__/metadata.test.ts b/packages/docusaurus-plugin-content-docs/src/__tests__/metadata.test.ts similarity index 100% rename from packages/docusaurus-plugin-content-docs-legacy/src/__tests__/metadata.test.ts rename to packages/docusaurus-plugin-content-docs/src/__tests__/metadata.test.ts diff --git a/packages/docusaurus-plugin-content-docs-legacy/src/__tests__/order.test.ts b/packages/docusaurus-plugin-content-docs/src/__tests__/order.test.ts similarity index 100% rename from packages/docusaurus-plugin-content-docs-legacy/src/__tests__/order.test.ts rename to packages/docusaurus-plugin-content-docs/src/__tests__/order.test.ts diff --git a/packages/docusaurus-plugin-content-docs-legacy/src/__tests__/sidebars.test.ts b/packages/docusaurus-plugin-content-docs/src/__tests__/sidebars.test.ts similarity index 100% rename from packages/docusaurus-plugin-content-docs-legacy/src/__tests__/sidebars.test.ts rename to packages/docusaurus-plugin-content-docs/src/__tests__/sidebars.test.ts diff --git a/packages/docusaurus-plugin-content-docs-legacy/src/index.ts b/packages/docusaurus-plugin-content-docs/src/index.ts similarity index 98% rename from packages/docusaurus-plugin-content-docs-legacy/src/index.ts rename to packages/docusaurus-plugin-content-docs/src/index.ts index bb0ef63f15..cd266b44f5 100644 --- a/packages/docusaurus-plugin-content-docs-legacy/src/index.ts +++ b/packages/docusaurus-plugin-content-docs/src/index.ts @@ -37,8 +37,8 @@ const DEFAULT_OPTIONS: PluginOptions = { routeBasePath: 'docs', // URL Route. include: ['**/*.md', '**/*.mdx'], // Extensions to include. sidebarPath: '', // Path to sidebar configuration for showing a list of markdown pages. - docLayoutComponent: '@theme/DocLegacyPage', - docItemComponent: '@theme/DocLegacyItem', + docLayoutComponent: '@theme/DocPage', + docItemComponent: '@theme/DocItem', remarkPlugins: [], rehypePlugins: [], }; @@ -52,7 +52,7 @@ export default function pluginContentDocs( let sourceToPermalink: SourceToPermalink = {}; return { - name: 'docusaurus-plugin-content-docs-legacy', + name: 'docusaurus-plugin-content-docs', getPathsToWatch() { const {include = []} = options; diff --git a/packages/docusaurus-plugin-content-docs-legacy/src/markdown/index.ts b/packages/docusaurus-plugin-content-docs/src/markdown/index.ts similarity index 100% rename from packages/docusaurus-plugin-content-docs-legacy/src/markdown/index.ts rename to packages/docusaurus-plugin-content-docs/src/markdown/index.ts diff --git a/packages/docusaurus-plugin-content-docs-legacy/src/metadata.ts b/packages/docusaurus-plugin-content-docs/src/metadata.ts similarity index 100% rename from packages/docusaurus-plugin-content-docs-legacy/src/metadata.ts rename to packages/docusaurus-plugin-content-docs/src/metadata.ts diff --git a/packages/docusaurus-plugin-content-docs-legacy/src/order.ts b/packages/docusaurus-plugin-content-docs/src/order.ts similarity index 100% rename from packages/docusaurus-plugin-content-docs-legacy/src/order.ts rename to packages/docusaurus-plugin-content-docs/src/order.ts diff --git a/packages/docusaurus-plugin-content-docs-legacy/src/sidebars.ts b/packages/docusaurus-plugin-content-docs/src/sidebars.ts similarity index 100% rename from packages/docusaurus-plugin-content-docs-legacy/src/sidebars.ts rename to packages/docusaurus-plugin-content-docs/src/sidebars.ts diff --git a/packages/docusaurus-plugin-content-docs-legacy/src/types.ts b/packages/docusaurus-plugin-content-docs/src/types.ts similarity index 100% rename from packages/docusaurus-plugin-content-docs-legacy/src/types.ts rename to packages/docusaurus-plugin-content-docs/src/types.ts diff --git a/packages/docusaurus-plugin-content-docs-legacy/tsconfig.json b/packages/docusaurus-plugin-content-docs/tsconfig.json similarity index 100% rename from packages/docusaurus-plugin-content-docs-legacy/tsconfig.json rename to packages/docusaurus-plugin-content-docs/tsconfig.json diff --git a/packages/docusaurus-preset-classic/package.json b/packages/docusaurus-preset-classic/package.json index b2cae556f4..c87296a2ba 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.25", - "@docusaurus/plugin-content-docs-legacy": "^2.0.0-alpha.25", + "@docusaurus/plugin-content-docs": "^2.0.0-alpha.25", "@docusaurus/plugin-content-pages": "^2.0.0-alpha.25", "@docusaurus/plugin-google-analytics": "^2.0.0-alpha.25", "@docusaurus/plugin-google-gtag": "^2.0.0-alpha.25", diff --git a/packages/docusaurus-preset-classic/src/index.js b/packages/docusaurus-preset-classic/src/index.js index c954f48a51..34584be04c 100644 --- a/packages/docusaurus-preset-classic/src/index.js +++ b/packages/docusaurus-preset-classic/src/index.js @@ -18,7 +18,7 @@ module.exports = function preset(context, opts = {}) { algolia && '@docusaurus/theme-search-algolia', ], plugins: [ - ['@docusaurus/plugin-content-docs-legacy', opts.docs], + ['@docusaurus/plugin-content-docs', opts.docs], ['@docusaurus/plugin-content-blog', opts.blog], ['@docusaurus/plugin-content-pages', opts.pages], isProd && googleAnalytics && '@docusaurus/plugin-google-analytics', diff --git a/packages/docusaurus-theme-classic/src/theme/DocLegacyItem/index.js b/packages/docusaurus-theme-classic/src/theme/DocItem/index.js similarity index 94% rename from packages/docusaurus-theme-classic/src/theme/DocLegacyItem/index.js rename to packages/docusaurus-theme-classic/src/theme/DocItem/index.js index 8db2241c64..bd6c783722 100644 --- a/packages/docusaurus-theme-classic/src/theme/DocLegacyItem/index.js +++ b/packages/docusaurus-theme-classic/src/theme/DocItem/index.js @@ -10,7 +10,7 @@ import React from 'react'; import Head from '@docusaurus/Head'; import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; import withBaseUrl from '@docusaurus/withBaseUrl'; -import DocLegacyPaginator from '@theme/DocLegacyPaginator'; +import DocPaginator from '@theme/DocPaginator'; import styles from './styles.module.css'; @@ -30,7 +30,7 @@ function Headings({headings, isChild}) { ); } -function DocLegacyItem(props) { +function DocItem(props) { const {siteConfig = {}} = useDocusaurusContext(); const {url: siteUrl} = siteConfig; const {metadata, content: DocContent} = props; @@ -91,7 +91,7 @@ function DocLegacyItem(props) { )}
- +
@@ -109,4 +109,4 @@ function DocLegacyItem(props) { ); } -export default DocLegacyItem; +export default DocItem; diff --git a/packages/docusaurus-theme-classic/src/theme/DocLegacyItem/styles.module.css b/packages/docusaurus-theme-classic/src/theme/DocItem/styles.module.css similarity index 100% rename from packages/docusaurus-theme-classic/src/theme/DocLegacyItem/styles.module.css rename to packages/docusaurus-theme-classic/src/theme/DocItem/styles.module.css diff --git a/packages/docusaurus-theme-classic/src/theme/DocLegacyPage/index.js b/packages/docusaurus-theme-classic/src/theme/DocPage/index.js similarity index 88% rename from packages/docusaurus-theme-classic/src/theme/DocLegacyPage/index.js rename to packages/docusaurus-theme-classic/src/theme/DocPage/index.js index 16ebad3041..dfb6917c40 100644 --- a/packages/docusaurus-theme-classic/src/theme/DocLegacyPage/index.js +++ b/packages/docusaurus-theme-classic/src/theme/DocPage/index.js @@ -10,12 +10,12 @@ import {MDXProvider} from '@mdx-js/react'; import renderRoutes from '@docusaurus/renderRoutes'; import Layout from '@theme/Layout'; -import DocLegacySidebar from '@theme/DocLegacySidebar'; +import DocSidebar from '@theme/DocSidebar'; import MDXComponents from '@theme/MDXComponents'; import styles from './styles.module.css'; -function DocLegacyPage(props) { +function DocPage(props) { const {route, docsMetadata, location} = props; const {permalinkToSidebar, docsSidebars} = docsMetadata; const sidebar = permalinkToSidebar[location.pathname.replace(/\/$/, '')]; @@ -24,7 +24,7 @@ function DocLegacyPage(props) {
-