mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-10 07:37:19 +02:00
chore(v2): make v2 docs plugin legacy (#1639)
* chore(v2): make v2 docs plugin legacy * chore(v2): update fixtures
This commit is contained in:
parent
702dba1c81
commit
e5e085b33d
27 changed files with 24 additions and 21 deletions
|
@ -1,7 +1,7 @@
|
||||||
{
|
{
|
||||||
"name": "@docusaurus/plugin-content-docs",
|
"name": "@docusaurus/plugin-content-docs-legacy",
|
||||||
"version": "2.0.0-alpha.19",
|
"version": "2.0.0-alpha.19",
|
||||||
"description": "Documentation plugin for Docusaurus",
|
"description": "Documentation plugin for legacy v1 Docusaurus docs",
|
||||||
"main": "src/index.js",
|
"main": "src/index.js",
|
||||||
"publishConfig": {
|
"publishConfig": {
|
||||||
"access": "public"
|
"access": "public"
|
|
@ -21,8 +21,8 @@ const DEFAULT_OPTIONS = {
|
||||||
// TODO: Change format to array.
|
// TODO: Change format to array.
|
||||||
sidebarPath: '', // Path to sidebar configuration for showing a list of markdown pages.
|
sidebarPath: '', // Path to sidebar configuration for showing a list of markdown pages.
|
||||||
// TODO: Settle themeing.
|
// TODO: Settle themeing.
|
||||||
docLayoutComponent: '@theme/DocPage',
|
docLayoutComponent: '@theme/DocLegacyPage',
|
||||||
docItemComponent: '@theme/DocItem',
|
docItemComponent: '@theme/DocLegacyItem',
|
||||||
remarkPlugins: [],
|
remarkPlugins: [],
|
||||||
rehypePlugins: [],
|
rehypePlugins: [],
|
||||||
};
|
};
|
|
@ -9,7 +9,7 @@
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@docusaurus/plugin-content-blog": "^2.0.0-alpha.19",
|
"@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-content-pages": "^2.0.0-alpha.19",
|
||||||
"@docusaurus/plugin-sitemap": "^2.0.0-alpha.19",
|
"@docusaurus/plugin-sitemap": "^2.0.0-alpha.19",
|
||||||
"@docusaurus/theme-classic": "^2.0.0-alpha.19",
|
"@docusaurus/theme-classic": "^2.0.0-alpha.19",
|
||||||
|
|
|
@ -17,7 +17,7 @@ module.exports = function preset(context, opts = {}) {
|
||||||
algolia && '@docusaurus/theme-search-algolia',
|
algolia && '@docusaurus/theme-search-algolia',
|
||||||
],
|
],
|
||||||
plugins: [
|
plugins: [
|
||||||
['@docusaurus/plugin-content-docs', opts.docs],
|
['@docusaurus/plugin-content-docs-legacy', opts.docs],
|
||||||
['@docusaurus/plugin-content-blog', opts.blog],
|
['@docusaurus/plugin-content-blog', opts.blog],
|
||||||
['@docusaurus/plugin-content-pages', opts.pages],
|
['@docusaurus/plugin-content-pages', opts.pages],
|
||||||
googleAnalytics && '@docusaurus/plugin-google-analytics',
|
googleAnalytics && '@docusaurus/plugin-google-analytics',
|
||||||
|
|
|
@ -8,7 +8,7 @@
|
||||||
import React from 'react';
|
import React from 'react';
|
||||||
|
|
||||||
import Head from '@docusaurus/Head';
|
import Head from '@docusaurus/Head';
|
||||||
import DocPaginator from '@theme/DocPaginator';
|
import DocLegacyPaginator from '@theme/DocLegacyPaginator';
|
||||||
|
|
||||||
import styles from './styles.module.css';
|
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;
|
const {metadata, content: DocContent, docsMetadata} = props;
|
||||||
|
|
||||||
return (
|
return (
|
||||||
|
@ -49,7 +49,10 @@ function DocItem(props) {
|
||||||
</div>
|
</div>
|
||||||
</article>
|
</article>
|
||||||
<div className="margin-top--xl margin-bottom--lg">
|
<div className="margin-top--xl margin-bottom--lg">
|
||||||
<DocPaginator docsMetadata={docsMetadata} metadata={metadata} />
|
<DocLegacyPaginator
|
||||||
|
docsMetadata={docsMetadata}
|
||||||
|
metadata={metadata}
|
||||||
|
/>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
@ -66,4 +69,4 @@ function DocItem(props) {
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
export default DocItem;
|
export default DocLegacyItem;
|
|
@ -10,10 +10,10 @@ import {MDXProvider} from '@mdx-js/react';
|
||||||
|
|
||||||
import renderRoutes from '@docusaurus/renderRoutes';
|
import renderRoutes from '@docusaurus/renderRoutes';
|
||||||
import Layout from '@theme/Layout';
|
import Layout from '@theme/Layout';
|
||||||
import DocSidebar from '@theme/DocSidebar';
|
import DocLegacySidebar from '@theme/DocLegacySidebar';
|
||||||
import MDXComponents from '@theme/MDXComponents';
|
import MDXComponents from '@theme/MDXComponents';
|
||||||
|
|
||||||
function DocPage(props) {
|
function DocLegacyPage(props) {
|
||||||
const {route, docsMetadata, location} = props;
|
const {route, docsMetadata, location} = props;
|
||||||
const {permalinkToId} = docsMetadata;
|
const {permalinkToId} = docsMetadata;
|
||||||
const id =
|
const id =
|
||||||
|
@ -27,7 +27,7 @@ function DocPage(props) {
|
||||||
<div className="container container--fluid">
|
<div className="container container--fluid">
|
||||||
<div className="row">
|
<div className="row">
|
||||||
<div className="col col--3">
|
<div className="col col--3">
|
||||||
<DocSidebar docsMetadata={docsMetadata} sidebar={sidebar} />
|
<DocLegacySidebar docsMetadata={docsMetadata} sidebar={sidebar} />
|
||||||
</div>
|
</div>
|
||||||
<main className="col">
|
<main className="col">
|
||||||
<MDXProvider components={MDXComponents}>
|
<MDXProvider components={MDXComponents}>
|
||||||
|
@ -40,4 +40,4 @@ function DocPage(props) {
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
export default DocPage;
|
export default DocLegacyPage;
|
|
@ -8,7 +8,7 @@
|
||||||
import React from 'react';
|
import React from 'react';
|
||||||
import Link from '@docusaurus/Link';
|
import Link from '@docusaurus/Link';
|
||||||
|
|
||||||
function DocPaginator(props) {
|
function DocLegacyPaginator(props) {
|
||||||
const {
|
const {
|
||||||
docsMetadata: {docs},
|
docsMetadata: {docs},
|
||||||
metadata,
|
metadata,
|
||||||
|
@ -44,4 +44,4 @@ function DocPaginator(props) {
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
export default DocPaginator;
|
export default DocLegacyPaginator;
|
|
@ -8,13 +8,13 @@
|
||||||
import React, {useState} from 'react';
|
import React, {useState} from 'react';
|
||||||
import classnames from 'classnames';
|
import classnames from 'classnames';
|
||||||
|
|
||||||
import Link from '@docusaurus/Link'; // eslint-disable-line
|
import Link from '@docusaurus/Link';
|
||||||
|
|
||||||
import styles from './styles.module.css';
|
import styles from './styles.module.css';
|
||||||
|
|
||||||
const MOBILE_TOGGLE_SIZE = 24;
|
const MOBILE_TOGGLE_SIZE = 24;
|
||||||
|
|
||||||
function DocSidebar(props) {
|
function DocLegacySidebar(props) {
|
||||||
const [showResponsiveSidebar, setShowResponsiveSidebar] = useState(false);
|
const [showResponsiveSidebar, setShowResponsiveSidebar] = useState(false);
|
||||||
const {docsMetadata, sidebar} = props;
|
const {docsMetadata, sidebar} = props;
|
||||||
|
|
||||||
|
@ -127,4 +127,4 @@ function DocSidebar(props) {
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
export default DocSidebar;
|
export default DocLegacySidebar;
|
|
@ -15,7 +15,7 @@ module.exports = {
|
||||||
favicon: 'img/docusaurus.ico',
|
favicon: 'img/docusaurus.ico',
|
||||||
plugins: [
|
plugins: [
|
||||||
[
|
[
|
||||||
'@docusaurus/plugin-content-docs',
|
'@docusaurus/plugin-content-docs-legacy',
|
||||||
{
|
{
|
||||||
path: '../docs',
|
path: '../docs',
|
||||||
sidebarPath: require.resolve('./sidebars.js'),
|
sidebarPath: require.resolve('./sidebars.js'),
|
||||||
|
|
|
@ -15,7 +15,7 @@ module.exports = {
|
||||||
favicon: 'img/docusaurus.ico',
|
favicon: 'img/docusaurus.ico',
|
||||||
plugins: [
|
plugins: [
|
||||||
[
|
[
|
||||||
'@docusaurus/plugin-content-docs',
|
'@docusaurus/plugin-content-docs-legacy',
|
||||||
{
|
{
|
||||||
path: '../docs',
|
path: '../docs',
|
||||||
sidebarPath: require.resolve('./sidebars.js'),
|
sidebarPath: require.resolve('./sidebars.js'),
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue