diff --git a/packages/create-docusaurus/templates/classic/package.json b/packages/create-docusaurus/templates/classic/package.json
index 3df1d1436177..6248aefec3e0 100644
--- a/packages/create-docusaurus/templates/classic/package.json
+++ b/packages/create-docusaurus/templates/classic/package.json
@@ -1,6 +1,6 @@
{
"name": "docusaurus-2-classic-template",
- "version": "2.0.0-beta.15",
+ "version": "2.0.0-beta.17",
"private": true,
"scripts": {
"docusaurus": "docusaurus",
@@ -14,8 +14,8 @@
"write-heading-ids": "docusaurus write-heading-ids"
},
"dependencies": {
- "@docusaurus/core": "2.0.0-beta.15",
- "@docusaurus/preset-classic": "2.0.0-beta.15",
+ "@docusaurus/core": "2.0.0-beta.17",
+ "@docusaurus/preset-classic": "2.0.0-beta.17",
"@mdx-js/react": "^1.6.22",
"clsx": "^1.1.1",
"prism-react-renderer": "^1.2.1",
diff --git a/packages/create-docusaurus/templates/classic/src/components/HomepageFeatures/index.js b/packages/create-docusaurus/templates/classic/src/components/HomepageFeatures/index.js
index 0529f8a0e7e5..78f410ba6888 100644
--- a/packages/create-docusaurus/templates/classic/src/components/HomepageFeatures/index.js
+++ b/packages/create-docusaurus/templates/classic/src/components/HomepageFeatures/index.js
@@ -39,7 +39,7 @@ function Feature({Svg, title, description}) {
return (
-
+
{title}
diff --git a/packages/create-docusaurus/templates/classic/src/pages/index.module.css b/packages/create-docusaurus/templates/classic/src/pages/index.module.css
index 666feb6a172a..9f71a5da775b 100644
--- a/packages/create-docusaurus/templates/classic/src/pages/index.module.css
+++ b/packages/create-docusaurus/templates/classic/src/pages/index.module.css
@@ -10,7 +10,7 @@
overflow: hidden;
}
-@media screen and (max-width: 966px) {
+@media screen and (max-width: 996px) {
.heroBanner {
padding: 2rem;
}
diff --git a/packages/create-docusaurus/templates/facebook/package.json b/packages/create-docusaurus/templates/facebook/package.json
index e6fb380c2458..d3a4bee43587 100644
--- a/packages/create-docusaurus/templates/facebook/package.json
+++ b/packages/create-docusaurus/templates/facebook/package.json
@@ -1,6 +1,6 @@
{
"name": "docusaurus-2-facebook-template",
- "version": "2.0.0-beta.15",
+ "version": "2.0.0-beta.17",
"private": true,
"scripts": {
"docusaurus": "docusaurus",
@@ -18,8 +18,8 @@
"format:diff": "prettier --config .prettierrc --list-different \"**/*.{js,jsx,ts,tsx,md,mdx}\""
},
"dependencies": {
- "@docusaurus/core": "2.0.0-beta.15",
- "@docusaurus/preset-classic": "2.0.0-beta.15",
+ "@docusaurus/core": "2.0.0-beta.17",
+ "@docusaurus/preset-classic": "2.0.0-beta.17",
"@mdx-js/react": "^1.6.22",
"clsx": "^1.1.1",
"react": "^17.0.1",
@@ -29,14 +29,14 @@
"@babel/eslint-parser": "^7.16.3",
"eslint": "^8.8.0",
"eslint-config-airbnb": "^19.0.0",
- "eslint-config-prettier": "^8.3.0",
+ "eslint-config-prettier": "^8.4.0",
"eslint-plugin-header": "^3.1.1",
"eslint-plugin-import": "^2.25.3",
"eslint-plugin-jsx-a11y": "^6.5.1",
- "eslint-plugin-react": "^7.27.0",
+ "eslint-plugin-react": "^7.29.2",
"eslint-plugin-react-hooks": "^4.3.0",
"prettier": "^2.5.1",
- "stylelint": "^14.3.0"
+ "stylelint": "^14.5.3"
},
"browserslist": {
"production": [
diff --git a/packages/create-docusaurus/templates/facebook/src/pages/styles.module.css b/packages/create-docusaurus/templates/facebook/src/pages/styles.module.css
index 76db00c17c0a..da1454b3f3b5 100644
--- a/packages/create-docusaurus/templates/facebook/src/pages/styles.module.css
+++ b/packages/create-docusaurus/templates/facebook/src/pages/styles.module.css
@@ -19,7 +19,7 @@
overflow: hidden;
}
-@media screen and (max-width: 966px) {
+@media screen and (max-width: 996px) {
.heroBanner {
padding: 2rem;
}
diff --git a/packages/create-docusaurus/templates/shared/docs/tutorial-basics/create-a-document.md b/packages/create-docusaurus/templates/shared/docs/tutorial-basics/create-a-document.md
index feaced79d0a3..a9bb9a4140b1 100644
--- a/packages/create-docusaurus/templates/shared/docs/tutorial-basics/create-a-document.md
+++ b/packages/create-docusaurus/templates/shared/docs/tutorial-basics/create-a-document.md
@@ -41,14 +41,14 @@ This is my **first Docusaurus document**!
It is also possible to create your sidebar explicitly in `sidebars.js`:
-```diff title="sidebars.js"
+```js title="sidebars.js"
module.exports = {
tutorialSidebar: [
{
type: 'category',
label: 'Tutorial',
-- items: [...],
-+ items: ['hello'],
+ // highlight-next-line
+ items: ['hello'],
},
],
};
diff --git a/packages/create-docusaurus/templates/shared/static/img/undraw_docusaurus_mountain.svg b/packages/create-docusaurus/templates/shared/static/img/undraw_docusaurus_mountain.svg
index 431cef2f7fec..af961c49a888 100644
--- a/packages/create-docusaurus/templates/shared/static/img/undraw_docusaurus_mountain.svg
+++ b/packages/create-docusaurus/templates/shared/static/img/undraw_docusaurus_mountain.svg
@@ -1,4 +1,5 @@
diff --git a/packages/docusaurus-plugin-content-blog/src/__tests__/__fixtures__/website/i18n/en/docusaurus-plugin-content-blog/authors.yml b/packages/docusaurus-plugin-content-blog/src/__tests__/__fixtures__/website/i18n/en/docusaurus-plugin-content-blog/authors.yml
index f42af6257f93..f509f4ff45ee 100644
--- a/packages/docusaurus-plugin-content-blog/src/__tests__/__fixtures__/website/i18n/en/docusaurus-plugin-content-blog/authors.yml
+++ b/packages/docusaurus-plugin-content-blog/src/__tests__/__fixtures__/website/i18n/en/docusaurus-plugin-content-blog/authors.yml
@@ -1,5 +1,4 @@
-
-
slorber:
name: Sébastien Lorber (translated)
title: Docusaurus maintainer (translated)
+ email: lorber.sebastien@gmail.com
diff --git a/packages/docusaurus-plugin-content-blog/src/__tests__/__snapshots__/feed.test.ts.snap b/packages/docusaurus-plugin-content-blog/src/__tests__/__snapshots__/feed.test.ts.snap
index 28d2e5b29413..67b84bc407ef 100644
--- a/packages/docusaurus-plugin-content-blog/src/__tests__/__snapshots__/feed.test.ts.snap
+++ b/packages/docusaurus-plugin-content-blog/src/__tests__/__snapshots__/feed.test.ts.snap
@@ -26,8 +26,7 @@ Array [
2021-03-05T00:00:00.000Z
-
HTML Heading 1HTML Heading 2
HTML Paragraph
Import DOM
Heading 1
Heading 2
Heading 3
Heading 4
Heading 5
Normal Text Italics Text Bold Text
link
-![\\"image\\"](\\"https://v2.docusaurus.io/\\")
]]>
+
HTML Heading 1HTML Heading 2
HTML Paragraph
Import DOM
Heading 1
Heading 2
Heading 3
Heading 4
Heading 5
Normal Text Italics Text Bold Text
link
]]>
<![CDATA[Complex Slug]]>
@@ -78,6 +77,7 @@ Array [
Sébastien Lorber (translated)
+ lorber.sebastien@gmail.com
",
@@ -103,7 +103,7 @@ Array [
},
{
\\"id\\": \\"/mdx-blog-post\\",
- \\"content_html\\": \\"
HTML Heading 1
HTML Heading 2
HTML Paragraph
Import DOM
Heading 1
Heading 2
Heading 3
Heading 4
Heading 5
Normal Text Italics Text Bold Text
link\\\\n![\\\\\\"image\\\\\\"](\\\\\\"https://v2.docusaurus.io/\\\\\\")
\\",
+ \\"content_html\\": \\"
HTML Heading 1
HTML Heading 2
HTML Paragraph
Import DOM
Heading 1
Heading 2
Heading 3
Heading 4
Heading 5
Normal Text Italics Text Bold Text
link
\\",
\\"url\\": \\"https://docusaurus.io/myBaseUrl/blog/mdx-blog-post\\",
\\"title\\": \\"Full Blog Sample\\",
\\"summary\\": \\"HTML Heading 1\\",
@@ -197,8 +197,7 @@ Array [
/mdx-blog-post
Fri, 05 Mar 2021 00:00:00 GMT
-
HTML Heading 1HTML Heading 2
HTML Paragraph
Import DOM
Heading 1
Heading 2
Heading 3
Heading 4
Heading 5
Normal Text Italics Text Bold Text
link
-
]]>
+
HTML Heading 1HTML Heading 2
HTML Paragraph
Import DOM
Heading 1
Heading 2
Heading 3
Heading 4
Heading 5
Normal Text Italics Text Bold Text
link
]]>
-
<![CDATA[Complex Slug]]>
@@ -240,6 +239,7 @@ Array [
Fri, 14 Dec 2018 00:00:00 GMT
Happy birthday!]]>
+ lorber.sebastien@gmail.com (Sébastien Lorber (translated))
",
diff --git a/packages/docusaurus-plugin-content-blog/src/__tests__/__snapshots__/index.test.ts.snap b/packages/docusaurus-plugin-content-blog/src/__tests__/__snapshots__/index.test.ts.snap
index 2c0eb4a630c9..1d788e5744a0 100644
--- a/packages/docusaurus-plugin-content-blog/src/__tests__/__snapshots__/index.test.ts.snap
+++ b/packages/docusaurus-plugin-content-blog/src/__tests__/__snapshots__/index.test.ts.snap
@@ -75,3 +75,64 @@ Object {
},
}
`;
+
+exports[`loadBlog test blog tags: no pagination 1`] = `
+Object {
+ "/blog/tags/tag-1": Object {
+ "items": Array [
+ "/simple/slug/another",
+ "/another/tags",
+ "/another/tags2",
+ ],
+ "name": "tag1",
+ "pages": Array [
+ Object {
+ "items": Array [
+ "/simple/slug/another",
+ "/another/tags",
+ "/another/tags2",
+ ],
+ "metadata": Object {
+ "blogDescription": "Blog",
+ "blogTitle": "Blog",
+ "nextPage": null,
+ "page": 1,
+ "permalink": "/blog/tags/tag-1",
+ "postsPerPage": 3,
+ "previousPage": null,
+ "totalCount": 3,
+ "totalPages": 1,
+ },
+ },
+ ],
+ "permalink": "/blog/tags/tag-1",
+ },
+ "/blog/tags/tag-2": Object {
+ "items": Array [
+ "/another/tags",
+ "/another/tags2",
+ ],
+ "name": "tag2",
+ "pages": Array [
+ Object {
+ "items": Array [
+ "/another/tags",
+ "/another/tags2",
+ ],
+ "metadata": Object {
+ "blogDescription": "Blog",
+ "blogTitle": "Blog",
+ "nextPage": null,
+ "page": 1,
+ "permalink": "/blog/tags/tag-2",
+ "postsPerPage": 2,
+ "previousPage": null,
+ "totalCount": 2,
+ "totalPages": 1,
+ },
+ },
+ ],
+ "permalink": "/blog/tags/tag-2",
+ },
+}
+`;
diff --git a/packages/docusaurus-plugin-content-blog/src/__tests__/__snapshots__/translations.test.ts.snap b/packages/docusaurus-plugin-content-blog/src/__tests__/__snapshots__/translations.test.ts.snap
index ba9ff2b59bdd..d2cb32ded063 100644
--- a/packages/docusaurus-plugin-content-blog/src/__tests__/__snapshots__/translations.test.ts.snap
+++ b/packages/docusaurus-plugin-content-blog/src/__tests__/__snapshots__/translations.test.ts.snap
@@ -22,6 +22,47 @@ Array [
]
`;
+exports[`translateContent should fallback when translation is incomplete 1`] = `
+Object {
+ "blogListPaginated": Array [
+ Object {
+ "items": Array [
+ "hello",
+ ],
+ "metadata": Object {
+ "blogDescription": "Someone's random blog",
+ "blogTitle": "My blog",
+ "nextPage": null,
+ "page": 1,
+ "permalink": "/",
+ "postsPerPage": 10,
+ "previousPage": null,
+ "totalCount": 1,
+ "totalPages": 1,
+ },
+ },
+ ],
+ "blogPosts": Array [
+ Object {
+ "id": "hello",
+ "metadata": Object {
+ "date": 2021-07-19T00:00:00.000Z,
+ "description": "/blog/2021/06/19/hello",
+ "formattedDate": "June 19, 2021",
+ "permalink": "/blog/2021/06/19/hello",
+ "source": "/blog/2021/06/19/hello",
+ "tags": Array [],
+ "title": "Hello",
+ "truncated": true,
+ },
+ },
+ ],
+ "blogSidebarTitle": "All my posts",
+ "blogTags": Object {},
+ "blogTagsListPath": "/tags",
+}
+`;
+
exports[`translateContent should return translated loaded content matching snapshot 1`] = `
Object {
"blogListPaginated": Array [
diff --git a/packages/docusaurus-plugin-content-blog/src/__tests__/blogFrontMatter.test.ts b/packages/docusaurus-plugin-content-blog/src/__tests__/blogFrontMatter.test.ts
index bc3aaf174cb0..67ee71969f05 100644
--- a/packages/docusaurus-plugin-content-blog/src/__tests__/blogFrontMatter.test.ts
+++ b/packages/docusaurus-plugin-content-blog/src/__tests__/blogFrontMatter.test.ts
@@ -54,9 +54,9 @@ function testField(params: {
)}`,
),
);
- } catch (e) {
+ } catch (err) {
// eslint-disable-next-line jest/no-conditional-expect
- expect(e.message).toMatch(new RegExp(escapeStringRegexp(message)));
+ expect(err.message).toMatch(new RegExp(escapeStringRegexp(message)));
}
});
});
diff --git a/packages/docusaurus-plugin-content-blog/src/__tests__/index.test.ts b/packages/docusaurus-plugin-content-blog/src/__tests__/index.test.ts
index 200bb84432f8..b3fad925a6c4 100644
--- a/packages/docusaurus-plugin-content-blog/src/__tests__/index.test.ts
+++ b/packages/docusaurus-plugin-content-blog/src/__tests__/index.test.ts
@@ -177,6 +177,7 @@ describe('loadBlog', () => {
name: 'Yangshun Tay (translated)',
},
{
+ email: 'lorber.sebastien@gmail.com',
key: 'slorber',
name: 'Sébastien Lorber (translated)',
title: 'Docusaurus maintainer (translated)',
@@ -479,4 +480,17 @@ describe('loadBlog', () => {
expect(Object.keys(blogTags).length).toEqual(2);
expect(blogTags).toMatchSnapshot();
});
+
+ test('test blog tags: no pagination', async () => {
+ const siteDir = path.join(
+ __dirname,
+ '__fixtures__',
+ 'website-blog-with-tags',
+ );
+ const blogTags = await getBlogTags(siteDir, {
+ postsPerPage: 'ALL',
+ });
+
+ expect(blogTags).toMatchSnapshot();
+ });
});
diff --git a/packages/docusaurus-plugin-content-blog/src/__tests__/linkify.test.ts b/packages/docusaurus-plugin-content-blog/src/__tests__/linkify.test.ts
index 9fe9a5149011..d745399331a3 100644
--- a/packages/docusaurus-plugin-content-blog/src/__tests__/linkify.test.ts
+++ b/packages/docusaurus-plugin-content-blog/src/__tests__/linkify.test.ts
@@ -43,8 +43,11 @@ const blogPosts: BlogPost[] = [
},
];
-const transform = (filePath: string, options?: Partial
) => {
- const fileContent = fs.readFileSync(filePath, 'utf-8');
+const transform = async (
+ filePath: string,
+ options?: Partial,
+) => {
+ const fileContent = await fs.readFile(filePath, 'utf-8');
const transformedContent = linkify({
filePath,
fileString: fileContent,
@@ -61,9 +64,9 @@ const transform = (filePath: string, options?: Partial) => {
return [fileContent, transformedContent];
};
-test('transform to correct link', () => {
+test('transform to correct link', async () => {
const post = path.join(contentPaths.contentPath, 'post.md');
- const [content, transformedContent] = transform(post);
+ const [content, transformedContent] = await transform(post);
expect(transformedContent).toMatchSnapshot();
expect(transformedContent).toContain(
'](/blog/2018/12/14/Happy-First-Birthday-Slash',
@@ -74,12 +77,12 @@ test('transform to correct link', () => {
expect(content).not.toEqual(transformedContent);
});
-test('report broken markdown links', () => {
+test('report broken markdown links', async () => {
const filePath = 'post-with-broken-links.md';
const folderPath = contentPaths.contentPath;
const postWithBrokenLinks = path.join(folderPath, filePath);
const onBrokenMarkdownLink = jest.fn();
- const [, transformedContent] = transform(postWithBrokenLinks, {
+ const [, transformedContent] = await transform(postWithBrokenLinks, {
onBrokenMarkdownLink,
});
expect(transformedContent).toMatchSnapshot();
diff --git a/packages/docusaurus-plugin-content-blog/src/__tests__/translations.test.ts b/packages/docusaurus-plugin-content-blog/src/__tests__/translations.test.ts
index 9844c4cab990..71cdd42af28a 100644
--- a/packages/docusaurus-plugin-content-blog/src/__tests__/translations.test.ts
+++ b/packages/docusaurus-plugin-content-blog/src/__tests__/translations.test.ts
@@ -77,6 +77,12 @@ describe('getContentTranslationFiles', () => {
});
describe('translateContent', () => {
+ test('should fallback when translation is incomplete', () => {
+ expect(
+ translateContent(sampleBlogContent, [{path: 'foo', content: {}}]),
+ ).toMatchSnapshot();
+ });
+
test('should not translate anything if translation files are untranslated', () => {
const translationFiles = getSampleTranslationFiles();
expect(translateContent(sampleBlogContent, translationFiles)).toEqual(
diff --git a/packages/docusaurus-plugin-content-blog/src/authors.ts b/packages/docusaurus-plugin-content-blog/src/authors.ts
index e69ec0c849d5..566da9a46ad5 100644
--- a/packages/docusaurus-plugin-content-blog/src/authors.ts
+++ b/packages/docusaurus-plugin-content-blog/src/authors.ts
@@ -24,6 +24,7 @@ const AuthorsMapSchema = Joi.object().pattern(
url: URISchema,
imageURL: URISchema,
title: Joi.string(),
+ email: Joi.string(),
})
.rename('image_url', 'imageURL')
.or('name', 'imageURL')
diff --git a/packages/docusaurus-plugin-content-blog/src/blogUtils.ts b/packages/docusaurus-plugin-content-blog/src/blogUtils.ts
index 9c082b3e4443..39d0b70b7be1 100644
--- a/packages/docusaurus-plugin-content-blog/src/blogUtils.ts
+++ b/packages/docusaurus-plugin-content-blog/src/blogUtils.ts
@@ -8,7 +8,7 @@
import fs from 'fs-extra';
import path from 'path';
import readingTime from 'reading-time';
-import {keyBy, mapValues} from 'lodash';
+import _ from 'lodash';
import type {
BlogPost,
BlogContentPaths,
@@ -46,9 +46,8 @@ export function truncate(fileString: string, truncateMarker: RegExp): string {
export function getSourceToPermalink(
blogPosts: BlogPost[],
): Record {
- return mapValues(
- keyBy(blogPosts, (item) => item.metadata.source),
- (v) => v.metadata.permalink,
+ return Object.fromEntries(
+ blogPosts.map(({metadata: {source, permalink}}) => [source, permalink]),
);
}
@@ -112,19 +111,16 @@ export function getBlogTags({
(blogPost) => blogPost.metadata.tags,
);
- return mapValues(groups, (group) => {
- const {tag, items: tagBlogPosts} = group;
- return {
- name: tag.label,
- items: tagBlogPosts.map((item) => item.id),
- permalink: tag.permalink,
- pages: paginateBlogPosts({
- blogPosts: tagBlogPosts,
- basePageUrl: group.tag.permalink,
- ...params,
- }),
- };
- });
+ return _.mapValues(groups, ({tag, items: tagBlogPosts}) => ({
+ name: tag.label,
+ items: tagBlogPosts.map((item) => item.id),
+ permalink: tag.permalink,
+ pages: paginateBlogPosts({
+ blogPosts: tagBlogPosts,
+ basePageUrl: tag.permalink,
+ ...params,
+ }),
+ }));
}
const DATE_FILENAME_REGEX =
@@ -143,10 +139,10 @@ export function parseBlogFileName(
if (dateFilenameMatch) {
const {folder, text, date: dateString} = dateFilenameMatch.groups!;
// Always treat dates as UTC by adding the `Z`
- const date = new Date(`${dateString}Z`);
- const slugDate = dateString.replace(/-/g, '/');
- const slug = `/${slugDate}/${folder}${text}`;
- return {date, text, slug};
+ const date = new Date(`${dateString!}Z`);
+ const slugDate = dateString!.replace(/-/g, '/');
+ const slug = `/${slugDate}/${folder!}${text!}`;
+ return {date, text: text!, slug};
}
const text = blogSourceRelative.replace(/(?:\/index)?\.mdx?$/, '');
const slug = `/${text}`;
@@ -161,8 +157,9 @@ function formatBlogPostDate(locale: string, date: Date): string {
year: 'numeric',
timeZone: 'UTC',
}).format(date);
- } catch (e) {
- throw new Error(`Can't format blog post date "${date}"`);
+ } catch (err) {
+ logger.error`Can't format blog post date "${String(date)}"`;
+ throw err;
}
}
@@ -176,12 +173,9 @@ async function parseBlogPostMarkdownFile(blogSourceAbsolute: string) {
...result,
frontMatter: validateBlogPostFrontMatter(result.frontMatter),
};
- } catch (e) {
- throw new Error(
- `Error while parsing blog post file ${blogSourceAbsolute}: "${
- (e as Error).message
- }".`,
- );
+ } catch (err) {
+ logger.error`Error while parsing blog post file path=${blogSourceAbsolute}.`;
+ throw err;
}
}
@@ -250,8 +244,8 @@ async function processBlogSourceFile(
includeAuthor: false,
});
return result.date;
- } catch (e) {
- logger.error(e);
+ } catch (err) {
+ logger.error(err);
return (await fs.stat(blogSourceAbsolute)).birthtime;
}
}
@@ -336,7 +330,7 @@ export async function generateBlogPosts(
): Promise {
const {include, exclude} = options;
- if (!fs.existsSync(contentPaths.contentPath)) {
+ if (!(await fs.pathExists(contentPaths.contentPath))) {
return [];
}
@@ -361,9 +355,9 @@ export async function generateBlogPosts(
options,
authorsMap,
);
- } catch (e) {
- logger.error`Processing of blog source file failed for path path=${blogSourceFile}.`;
- throw e;
+ } catch (err) {
+ logger.error`Processing of blog source file path=${blogSourceFile} failed.`;
+ throw err;
}
}),
)
diff --git a/packages/docusaurus-plugin-content-blog/src/feed.ts b/packages/docusaurus-plugin-content-blog/src/feed.ts
index 1357135e60ba..eb5908977d7e 100644
--- a/packages/docusaurus-plugin-content-blog/src/feed.ts
+++ b/packages/docusaurus-plugin-content-blog/src/feed.ts
@@ -57,9 +57,7 @@ async function generateBlogFeed({
});
function toFeedAuthor(author: Author): FeedAuthor {
- // TODO ask author emails?
- // RSS feed requires email to render authors
- return {name: author.name, link: author.url};
+ return {name: author.name, link: author.url, email: author.email};
}
await mapAsyncSequential(blogPosts, async (post) => {
diff --git a/packages/docusaurus-plugin-content-blog/src/index.ts b/packages/docusaurus-plugin-content-blog/src/index.ts
index a49529224a9d..a1f92f23e97f 100644
--- a/packages/docusaurus-plugin-content-blog/src/index.ts
+++ b/packages/docusaurus-plugin-content-blog/src/index.ts
@@ -307,7 +307,7 @@ export default async function pluginContentBlog(
({
content: {
__import: true,
- path: blogItemsToMetadata[postID].source,
+ path: blogItemsToMetadata[postID]!.source,
query: {
truncated: true,
},
@@ -359,7 +359,7 @@ export default async function pluginContentBlog(
modules: {
sidebar: aliasedSource(sidebarProp),
items: items.map((postID) => {
- const blogPostMetadata = blogItemsToMetadata[postID];
+ const blogPostMetadata = blogItemsToMetadata[postID]!;
return {
content: {
__import: true,
diff --git a/packages/docusaurus-plugin-content-blog/src/plugin-content-blog.d.ts b/packages/docusaurus-plugin-content-blog/src/plugin-content-blog.d.ts
index be228da2fad2..411f95ced3e3 100644
--- a/packages/docusaurus-plugin-content-blog/src/plugin-content-blog.d.ts
+++ b/packages/docusaurus-plugin-content-blog/src/plugin-content-blog.d.ts
@@ -21,6 +21,7 @@ declare module '@docusaurus/plugin-content-blog' {
imageURL?: string;
url?: string;
title?: string;
+ email?: string;
}
export type BlogPostFrontMatter = {
@@ -191,8 +192,7 @@ declare module '@theme/BlogPostPage' {
readonly content: Content;
}
- const BlogPostPage: (props: Props) => JSX.Element;
- export default BlogPostPage;
+ export default function BlogPostPage(props: Props): JSX.Element;
}
declare module '@theme/BlogListPage' {
@@ -217,8 +217,7 @@ declare module '@theme/BlogListPage' {
readonly items: readonly {readonly content: Content}[];
}
- const BlogListPage: (props: Props) => JSX.Element;
- export default BlogListPage;
+ export default function BlogListPage(props: Props): JSX.Element;
}
declare module '@theme/BlogTagsListPage' {
@@ -237,8 +236,7 @@ declare module '@theme/BlogTagsListPage' {
readonly tags: Readonly>;
}
- const BlogTagsListPage: (props: Props) => JSX.Element;
- export default BlogTagsListPage;
+ export default function BlogTagsListPage(props: Props): JSX.Element;
}
declare module '@theme/BlogTagsPostsPage' {
@@ -254,8 +252,7 @@ declare module '@theme/BlogTagsPostsPage' {
readonly items: readonly {readonly content: Content}[];
}
- const BlogTagsPostsPage: (props: Props) => JSX.Element;
- export default BlogTagsPostsPage;
+ export default function BlogTagsPostsPage(props: Props): JSX.Element;
}
declare module '@theme/BlogArchivePage' {
diff --git a/packages/docusaurus-plugin-content-blog/src/translations.ts b/packages/docusaurus-plugin-content-blog/src/translations.ts
index 09598e59ab0f..460e24a62480 100644
--- a/packages/docusaurus-plugin-content-blog/src/translations.ts
+++ b/packages/docusaurus-plugin-content-blog/src/translations.ts
@@ -19,8 +19,9 @@ function translateListPage(
items,
metadata: {
...metadata,
- blogTitle: translations.title.message,
- blogDescription: translations.description.message,
+ blogTitle: translations.title?.message ?? page.metadata.blogTitle,
+ blogDescription:
+ translations.description?.message ?? page.metadata.blogDescription,
},
};
});
@@ -52,10 +53,11 @@ export function translateContent(
content: BlogContent,
translationFiles: TranslationFiles,
): BlogContent {
- const [{content: optionsTranslations}] = translationFiles;
+ const {content: optionsTranslations} = translationFiles[0]!;
return {
...content,
- blogSidebarTitle: optionsTranslations['sidebar.title'].message,
+ blogSidebarTitle:
+ optionsTranslations['sidebar.title']?.message ?? content.blogSidebarTitle,
blogListPaginated: translateListPage(
content.blogListPaginated,
optionsTranslations,
diff --git a/packages/docusaurus-plugin-content-docs/package.json b/packages/docusaurus-plugin-content-docs/package.json
index 7fd9386f3ee0..42407dd4b3f3 100644
--- a/packages/docusaurus-plugin-content-docs/package.json
+++ b/packages/docusaurus-plugin-content-docs/package.json
@@ -1,6 +1,6 @@
{
"name": "@docusaurus/plugin-content-docs",
- "version": "2.0.0-beta.15",
+ "version": "2.0.0-beta.17",
"description": "Docs plugin for Docusaurus.",
"main": "lib/index.js",
"exports": {
@@ -23,24 +23,24 @@
},
"license": "MIT",
"dependencies": {
- "@docusaurus/core": "2.0.0-beta.15",
- "@docusaurus/logger": "2.0.0-beta.15",
- "@docusaurus/mdx-loader": "2.0.0-beta.15",
- "@docusaurus/utils": "2.0.0-beta.15",
- "@docusaurus/utils-validation": "2.0.0-beta.15",
+ "@docusaurus/core": "2.0.0-beta.17",
+ "@docusaurus/logger": "2.0.0-beta.17",
+ "@docusaurus/mdx-loader": "2.0.0-beta.17",
+ "@docusaurus/utils": "2.0.0-beta.17",
+ "@docusaurus/utils-validation": "2.0.0-beta.17",
"combine-promises": "^1.1.0",
- "fs-extra": "^10.0.0",
+ "fs-extra": "^10.0.1",
"import-fresh": "^3.3.0",
"js-yaml": "^4.1.0",
"lodash": "^4.17.21",
"remark-admonitions": "^1.2.1",
"tslib": "^2.3.1",
"utility-types": "^3.10.0",
- "webpack": "^5.68.0"
+ "webpack": "^5.69.1"
},
"devDependencies": {
- "@docusaurus/module-type-aliases": "2.0.0-beta.15",
- "@docusaurus/types": "2.0.0-beta.15",
+ "@docusaurus/module-type-aliases": "2.0.0-beta.17",
+ "@docusaurus/types": "2.0.0-beta.17",
"@types/js-yaml": "^4.0.5",
"@types/picomatch": "^2.3.0",
"commander": "^5.1.0",
diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/docs.test.ts.snap b/packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/docs.test.ts.snap
index d8ad2b8a3ee8..b66f4a4929c5 100644
--- a/packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/docs.test.ts.snap
+++ b/packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/docs.test.ts.snap
@@ -1,144 +1,244 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`simple site custom pagination 1`] = `
-Array [
- Array [
- undefined,
- Object {
- "permalink": "/docs/headingAsTitle",
- "title": "My heading as title",
- },
- ],
- Array [
- undefined,
- undefined,
- ],
- Array [
- Object {
- "permalink": "/docs/foo/bar",
- "title": "Bar",
- },
- Object {
- "permalink": "/docs/absoluteSlug",
- "title": "absoluteSlug",
- },
- ],
- Array [
- Object {
- "permalink": "/docs/doc with space",
- "title": "Hoo hoo, if this path tricks you...",
- },
- Object {
- "permalink": "/docs/",
- "title": "Hello sidebar_label",
- },
- ],
- Array [
- Object {
- "permalink": "/docs/headingAsTitle",
- "title": "My heading as title",
- },
- Object {
- "permalink": "/docs/ipsum",
- "title": "ipsum",
- },
- ],
- Array [
- Object {
- "permalink": "/docs/",
- "title": "Hello sidebar_label",
- },
- Object {
- "permalink": "/docs/lorem",
- "title": "lorem",
- },
- ],
- Array [
- Object {
- "permalink": "/docs/ipsum",
- "title": "ipsum",
- },
- Object {
- "permalink": "/docs/rootAbsoluteSlug",
- "title": "rootAbsoluteSlug",
- },
- ],
- Array [
- Object {
- "permalink": "/docs/foo/bazSlug.html",
- "title": "baz pagination_label",
- },
- Object {
- "permalink": "/docs/headingAsTitle",
- "title": "My heading as title",
- },
- ],
- Array [
- Object {
- "permalink": "/docs/foo/bazSlug.html",
- "title": "baz pagination_label",
- },
- Object {
- "permalink": "/docs/headingAsTitle",
- "title": "My heading as title",
- },
- ],
- Array [
- Object {
- "permalink": "/docs/foo/bazSlug.html",
- "title": "baz pagination_label",
- },
- Object {
- "permalink": "/docs/headingAsTitle",
- "title": "My heading as title",
- },
- ],
- Array [
- Object {
- "permalink": "/docs/foo/bazSlug.html",
- "title": "baz pagination_label",
- },
- Object {
- "permalink": "/docs/headingAsTitle",
- "title": "My heading as title",
- },
- ],
- Array [
- Object {
- "permalink": "/docs/foo/bazSlug.html",
- "title": "baz pagination_label",
- },
- Object {
- "permalink": "/docs/slugs/relativeSlug",
- "title": "relativeSlug",
- },
- ],
- Array [
- Object {
- "permalink": "/docs/absoluteSlug",
- "title": "absoluteSlug",
- },
- Object {
- "permalink": "/docs/slugs/hey/resolvedSlug",
- "title": "resolvedSlug",
- },
- ],
- Array [
- Object {
- "permalink": "/docs/slugs/relativeSlug",
- "title": "relativeSlug",
- },
- Object {
- "permalink": "/docs/tryToEscapeSlug",
- "title": "tryToEscapeSlug",
- },
- ],
- Array [
- Object {
- "permalink": "/docs/slugs/hey/resolvedSlug",
- "title": "resolvedSlug",
+Object {
+ "pagination": Array [
+ Object {
+ "id": "doc with space",
+ "next": Object {
+ "permalink": "/docs/foo/bar",
+ "title": "Bar",
+ },
+ "prev": undefined,
+ },
+ Object {
+ "id": "foo/bar",
+ "next": undefined,
+ "prev": undefined,
+ },
+ Object {
+ "id": "foo/baz",
+ "next": Object {
+ "permalink": "/docs/headingAsTitle",
+ "title": "My heading as title",
+ },
+ "prev": Object {
+ "permalink": "/docs/foo/bar",
+ "title": "Bar",
+ },
+ },
+ Object {
+ "id": "headingAsTitle",
+ "next": Object {
+ "permalink": "/docs/",
+ "title": "Hello sidebar_label",
+ },
+ "prev": Object {
+ "permalink": "/docs/foo/bazSlug.html",
+ "title": "baz pagination_label",
+ },
+ },
+ Object {
+ "id": "hello",
+ "next": Object {
+ "permalink": "/docs/ipsum",
+ "title": "ipsum",
+ },
+ "prev": Object {
+ "permalink": "/docs/headingAsTitle",
+ "title": "My heading as title",
+ },
+ },
+ Object {
+ "id": "ipsum",
+ "next": Object {
+ "permalink": "/docs/lorem",
+ "title": "lorem",
+ },
+ "prev": Object {
+ "permalink": "/docs/",
+ "title": "Hello sidebar_label",
+ },
+ },
+ Object {
+ "id": "lorem",
+ "next": Object {
+ "permalink": "/docs/rootAbsoluteSlug",
+ "title": "rootAbsoluteSlug",
+ },
+ "prev": Object {
+ "permalink": "/docs/ipsum",
+ "title": "ipsum",
+ },
+ },
+ Object {
+ "id": "rootAbsoluteSlug",
+ "next": Object {
+ "permalink": "/docs/headingAsTitle",
+ "title": "My heading as title",
+ },
+ "prev": Object {
+ "permalink": "/docs/foo/bazSlug.html",
+ "title": "baz pagination_label",
+ },
+ },
+ Object {
+ "id": "rootRelativeSlug",
+ "next": Object {
+ "permalink": "/docs/headingAsTitle",
+ "title": "My heading as title",
+ },
+ "prev": Object {
+ "permalink": "/docs/foo/bazSlug.html",
+ "title": "baz pagination_label",
+ },
+ },
+ Object {
+ "id": "rootResolvedSlug",
+ "next": Object {
+ "permalink": "/docs/headingAsTitle",
+ "title": "My heading as title",
+ },
+ "prev": Object {
+ "permalink": "/docs/foo/bazSlug.html",
+ "title": "baz pagination_label",
+ },
+ },
+ Object {
+ "id": "rootTryToEscapeSlug",
+ "next": Object {
+ "permalink": "/docs/headingAsTitle",
+ "title": "My heading as title",
+ },
+ "prev": Object {
+ "permalink": "/docs/foo/bazSlug.html",
+ "title": "baz pagination_label",
+ },
+ },
+ Object {
+ "id": "slugs/absoluteSlug",
+ "next": Object {
+ "permalink": "/docs/slugs/relativeSlug",
+ "title": "relativeSlug",
+ },
+ "prev": Object {
+ "permalink": "/docs/rootTryToEscapeSlug",
+ "title": "rootTryToEscapeSlug",
+ },
+ },
+ Object {
+ "id": "slugs/relativeSlug",
+ "next": Object {
+ "permalink": "/docs/slugs/hey/resolvedSlug",
+ "title": "resolvedSlug",
+ },
+ "prev": Object {
+ "permalink": "/docs/absoluteSlug",
+ "title": "absoluteSlug",
+ },
+ },
+ Object {
+ "id": "slugs/resolvedSlug",
+ "next": Object {
+ "permalink": "/docs/tryToEscapeSlug",
+ "title": "tryToEscapeSlug",
+ },
+ "prev": Object {
+ "permalink": "/docs/slugs/relativeSlug",
+ "title": "relativeSlug",
+ },
+ },
+ Object {
+ "id": "slugs/tryToEscapeSlug",
+ "next": undefined,
+ "prev": Object {
+ "permalink": "/docs/slugs/hey/resolvedSlug",
+ "title": "resolvedSlug",
+ },
},
- undefined,
],
-]
+ "sidebars": Object {
+ "defaultSidebar": Array [
+ Object {
+ "id": "doc with space",
+ "type": "doc",
+ },
+ Object {
+ "collapsed": false,
+ "collapsible": true,
+ "items": Array [
+ Object {
+ "id": "foo/bar",
+ "type": "doc",
+ },
+ Object {
+ "id": "foo/baz",
+ "type": "doc",
+ },
+ ],
+ "label": "foo",
+ "link": undefined,
+ "type": "category",
+ },
+ Object {
+ "id": "headingAsTitle",
+ "type": "doc",
+ },
+ Object {
+ "id": "hello",
+ "label": "Hello sidebar_label",
+ "type": "doc",
+ },
+ Object {
+ "id": "ipsum",
+ "type": "doc",
+ },
+ Object {
+ "id": "lorem",
+ "type": "doc",
+ },
+ Object {
+ "id": "rootAbsoluteSlug",
+ "type": "doc",
+ },
+ Object {
+ "id": "rootRelativeSlug",
+ "type": "doc",
+ },
+ Object {
+ "id": "rootResolvedSlug",
+ "type": "doc",
+ },
+ Object {
+ "id": "rootTryToEscapeSlug",
+ "type": "doc",
+ },
+ Object {
+ "collapsed": false,
+ "collapsible": true,
+ "items": Array [
+ Object {
+ "id": "slugs/absoluteSlug",
+ "type": "doc",
+ },
+ Object {
+ "id": "slugs/relativeSlug",
+ "type": "doc",
+ },
+ Object {
+ "id": "slugs/resolvedSlug",
+ "type": "doc",
+ },
+ Object {
+ "id": "slugs/tryToEscapeSlug",
+ "type": "doc",
+ },
+ ],
+ "label": "slugs",
+ "link": undefined,
+ "type": "category",
+ },
+ ],
+ },
+}
`;
diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/cli.test.ts b/packages/docusaurus-plugin-content-docs/src/__tests__/cli.test.ts
index 46fd8f0e929f..06edd9d6ee0c 100644
--- a/packages/docusaurus-plugin-content-docs/src/__tests__/cli.test.ts
+++ b/packages/docusaurus-plugin-content-docs/src/__tests__/cli.test.ts
@@ -73,8 +73,8 @@ describe('docsVersion', () => {
DEFAULT_PLUGIN_ID,
DEFAULT_OPTIONS,
),
- ).rejects.toThrowErrorMatchingInlineSnapshot(
- `"[docs]: invalid version tag specified! Do not include slash (/) or backslash (\\\\). Try something like: 1.0.0."`,
+ ).rejects.toThrowError(
+ '[docs]: invalid version tag specified! Do not include slash (/) or backslash (\\). Try something like: 1.0.0.',
);
await expect(() =>
cliDocsVersionCommand(
@@ -83,8 +83,8 @@ describe('docsVersion', () => {
DEFAULT_PLUGIN_ID,
DEFAULT_OPTIONS,
),
- ).rejects.toThrowErrorMatchingInlineSnapshot(
- `"[docs]: invalid version tag specified! Do not include slash (/) or backslash (\\\\). Try something like: 1.0.0."`,
+ ).rejects.toThrowError(
+ '[docs]: invalid version tag specified! Do not include slash (/) or backslash (\\). Try something like: 1.0.0.',
);
});
@@ -185,9 +185,9 @@ describe('docsVersion', () => {
});
test('first time versioning', async () => {
- const copyMock = jest.spyOn(fs, 'copySync').mockImplementation();
- const ensureMock = jest.spyOn(fs, 'ensureDirSync').mockImplementation();
- const writeMock = jest.spyOn(fs, 'writeFileSync');
+ const copyMock = jest.spyOn(fs, 'copy').mockImplementation();
+ const ensureMock = jest.spyOn(fs, 'ensureDir').mockImplementation();
+ const writeMock = jest.spyOn(fs, 'writeFile');
let versionedSidebar;
let versionedSidebarPath;
writeMock.mockImplementationOnce((filepath, content) => {
@@ -242,9 +242,9 @@ describe('docsVersion', () => {
});
test('not the first time versioning', async () => {
- const copyMock = jest.spyOn(fs, 'copySync').mockImplementation();
- const ensureMock = jest.spyOn(fs, 'ensureDirSync').mockImplementation();
- const writeMock = jest.spyOn(fs, 'writeFileSync');
+ const copyMock = jest.spyOn(fs, 'copy').mockImplementation();
+ const ensureMock = jest.spyOn(fs, 'ensureDir').mockImplementation();
+ const writeMock = jest.spyOn(fs, 'writeFile');
let versionedSidebar;
let versionedSidebarPath;
writeMock.mockImplementationOnce((filepath, content) => {
@@ -301,9 +301,9 @@ describe('docsVersion', () => {
test('second docs instance versioning', async () => {
const pluginId = 'community';
- const copyMock = jest.spyOn(fs, 'copySync').mockImplementation();
- const ensureMock = jest.spyOn(fs, 'ensureDirSync').mockImplementation();
- const writeMock = jest.spyOn(fs, 'writeFileSync');
+ const copyMock = jest.spyOn(fs, 'copy').mockImplementation();
+ const ensureMock = jest.spyOn(fs, 'ensureDir').mockImplementation();
+ const writeMock = jest.spyOn(fs, 'writeFile');
let versionedSidebar;
let versionedSidebarPath;
writeMock.mockImplementationOnce((filepath, content) => {
diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/docFrontMatter.test.ts b/packages/docusaurus-plugin-content-docs/src/__tests__/docFrontMatter.test.ts
index 7046cee91cbb..1a648a0eb628 100644
--- a/packages/docusaurus-plugin-content-docs/src/__tests__/docFrontMatter.test.ts
+++ b/packages/docusaurus-plugin-content-docs/src/__tests__/docFrontMatter.test.ts
@@ -51,9 +51,9 @@ function testField(params: {
)}`,
),
);
- } catch (e) {
+ } catch (err) {
// eslint-disable-next-line jest/no-conditional-expect
- expect(e.message).toMatch(new RegExp(escapeStringRegexp(message)));
+ expect(err.message).toMatch(new RegExp(escapeStringRegexp(message)));
}
});
});
diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/docs.test.ts b/packages/docusaurus-plugin-content-docs/src/__tests__/docs.test.ts
index f00525b88ea7..0c1d36d50a40 100644
--- a/packages/docusaurus-plugin-content-docs/src/__tests__/docs.test.ts
+++ b/packages/docusaurus-plugin-content-docs/src/__tests__/docs.test.ts
@@ -15,6 +15,7 @@ import {
isCategoryIndex,
} from '../docs';
import {loadSidebars} from '../sidebars';
+import type {Sidebars} from '../sidebars/types';
import {readVersionsMetadata} from '../versions';
import type {
DocFile,
@@ -120,18 +121,17 @@ function createTestUtils({
expect(metadata.permalink).toEqual(expectedPermalink);
}
- async function generateNavigation(
- docFiles: DocFile[],
- ): Promise<[DocNavLink | undefined, DocNavLink | undefined][]> {
- const rawDocs = await Promise.all(
- docFiles.map((docFile) =>
- processDocMetadata({
- docFile,
- versionMetadata,
- context,
- options,
- }),
- ),
+ async function generateNavigation(docFiles: DocFile[]): Promise<{
+ pagination: {prev?: DocNavLink; next?: DocNavLink; id: string}[];
+ sidebars: Sidebars;
+ }> {
+ const rawDocs = docFiles.map((docFile) =>
+ processDocMetadata({
+ docFile,
+ versionMetadata,
+ context,
+ options,
+ }),
);
const sidebars = await loadSidebars(versionMetadata.sidebarFilePath, {
sidebarItemsGenerator: ({defaultSidebarItemsGenerator, ...args}) =>
@@ -147,11 +147,14 @@ function createTestUtils({
});
const sidebarsUtils = createSidebarsUtils(sidebars);
- return addDocNavigation(
- rawDocs,
- sidebarsUtils,
- versionMetadata.sidebarFilePath as string,
- ).map((doc) => [doc.previous, doc.next]);
+ return {
+ pagination: addDocNavigation(
+ rawDocs,
+ sidebarsUtils,
+ versionMetadata.sidebarFilePath as string,
+ ).map((doc) => ({prev: doc.previous, next: doc.next, id: doc.id})),
+ sidebars,
+ };
}
return {processDocFile, testMeta, testSlug, generateNavigation};
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 5ea80609e119..bcbaa522a8a5 100644
--- a/packages/docusaurus-plugin-content-docs/src/__tests__/index.test.ts
+++ b/packages/docusaurus-plugin-content-docs/src/__tests__/index.test.ts
@@ -8,7 +8,7 @@
import path from 'path';
import {isMatch} from 'picomatch';
import commander from 'commander';
-import {kebabCase, orderBy} from 'lodash';
+import _ from 'lodash';
import fs from 'fs-extra';
import pluginContentDocs from '../index';
@@ -89,7 +89,7 @@ Entries created:
checkVersionMetadataPropCreated: (version: LoadedVersion) => {
const versionMetadataProp = getCreatedDataByPrefix(
- `version-${kebabCase(version.versionName)}-metadata-prop`,
+ `version-${_.kebabCase(version.versionName)}-metadata-prop`,
);
expect(versionMetadataProp.docsSidebars).toEqual(toSidebarsProp(version));
},
@@ -815,7 +815,7 @@ describe('site with custom sidebar items generator', () => {
): SidebarItemsGeneratorOptionArgs {
return {
...arg,
- docs: orderBy(arg.docs, 'id'),
+ docs: _.orderBy(arg.docs, 'id'),
version: {
...arg.version,
contentPath: path.relative(siteDir, arg.version.contentPath),
diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/lastUpdate.test.ts b/packages/docusaurus-plugin-content-docs/src/__tests__/lastUpdate.test.ts
index 6e90dc54d67a..01356ccdcb05 100644
--- a/packages/docusaurus-plugin-content-docs/src/__tests__/lastUpdate.test.ts
+++ b/packages/docusaurus-plugin-content-docs/src/__tests__/lastUpdate.test.ts
@@ -5,7 +5,7 @@
* LICENSE file in the root directory of this source tree.
*/
-import fs from 'fs';
+import fs from 'fs-extra';
import path from 'path';
import shell from 'shelljs';
@@ -64,9 +64,9 @@ describe('lastUpdate', () => {
test('temporary created file that has no git timestamp', async () => {
const tempFilePath = path.join(__dirname, '__fixtures__', '.temp');
- fs.writeFileSync(tempFilePath, 'Lorem ipsum :)');
+ await fs.writeFile(tempFilePath, 'Lorem ipsum :)');
await expect(getFileLastUpdate(tempFilePath)).resolves.toBeNull();
- fs.unlinkSync(tempFilePath);
+ await fs.unlink(tempFilePath);
});
test('Git does not exist', async () => {
diff --git a/packages/docusaurus-plugin-content-docs/src/categoryGeneratedIndex.ts b/packages/docusaurus-plugin-content-docs/src/categoryGeneratedIndex.ts
index ac2cb55e1ed9..522ae1455656 100644
--- a/packages/docusaurus-plugin-content-docs/src/categoryGeneratedIndex.ts
+++ b/packages/docusaurus-plugin-content-docs/src/categoryGeneratedIndex.ts
@@ -21,10 +21,6 @@ function getCategoryGeneratedIndexMetadata({
}): CategoryGeneratedIndexMetadata {
const {sidebarName, previous, next} =
sidebarsUtils.getCategoryGeneratedIndexNavigation(category.link.permalink);
- if (!sidebarName) {
- throw new Error('unexpected');
- }
-
return {
title: category.link.title ?? category.label,
description: category.link.description,
@@ -32,7 +28,7 @@ function getCategoryGeneratedIndexMetadata({
keywords: category.link.keywords,
slug: category.link.slug,
permalink: category.link.permalink,
- sidebar: sidebarName,
+ sidebar: sidebarName!,
previous: toNavigationLink(previous, docsById),
next: toNavigationLink(next, docsById),
};
diff --git a/packages/docusaurus-plugin-content-docs/src/cli.ts b/packages/docusaurus-plugin-content-docs/src/cli.ts
index a4cf9ee0549d..fea26eae586f 100644
--- a/packages/docusaurus-plugin-content-docs/src/cli.ts
+++ b/packages/docusaurus-plugin-content-docs/src/cli.ts
@@ -47,8 +47,8 @@ async function createVersionedSidebarFile({
versionedSidebarsDir,
`version-${version}-sidebars.json`,
);
- fs.ensureDirSync(path.dirname(newSidebarFile));
- fs.writeFileSync(
+ await fs.ensureDir(path.dirname(newSidebarFile));
+ await fs.writeFile(
newSidebarFile,
`${JSON.stringify(sidebars, null, 2)}\n`,
'utf8',
@@ -104,8 +104,8 @@ export async function cliDocsVersionCommand(
// Load existing versions.
let versions = [];
const versionsJSONFile = getVersionsFilePath(siteDir, pluginId);
- if (fs.existsSync(versionsJSONFile)) {
- versions = JSON.parse(fs.readFileSync(versionsJSONFile, 'utf8'));
+ if (await fs.pathExists(versionsJSONFile)) {
+ versions = JSON.parse(await fs.readFile(versionsJSONFile, 'utf8'));
}
// Check if version already exists.
@@ -120,10 +120,13 @@ export async function cliDocsVersionCommand(
// Copy docs files.
const docsDir = path.join(siteDir, docsPath);
- if (fs.existsSync(docsDir) && fs.readdirSync(docsDir).length > 0) {
+ if (
+ (await fs.pathExists(docsDir)) &&
+ (await fs.readdir(docsDir)).length > 0
+ ) {
const versionedDir = getVersionedDocsDirPath(siteDir, pluginId);
const newVersionDir = path.join(versionedDir, `version-${version}`);
- fs.copySync(docsDir, newVersionDir);
+ await fs.copy(docsDir, newVersionDir);
} else {
throw new Error(`${pluginIdLogPrefix}: there is no docs to version!`);
}
@@ -137,8 +140,11 @@ export async function cliDocsVersionCommand(
// Update versions.json file.
versions.unshift(version);
- fs.ensureDirSync(path.dirname(versionsJSONFile));
- fs.writeFileSync(versionsJSONFile, `${JSON.stringify(versions, null, 2)}\n`);
+ await fs.ensureDir(path.dirname(versionsJSONFile));
+ await fs.writeFile(
+ versionsJSONFile,
+ `${JSON.stringify(versions, null, 2)}\n`,
+ );
logger.success`name=${pluginIdLogPrefix}: version name=${version} created!`;
}
diff --git a/packages/docusaurus-plugin-content-docs/src/client/__tests__/docsClientUtils.test.ts b/packages/docusaurus-plugin-content-docs/src/client/__tests__/docsClientUtils.test.ts
index 0a414d474950..d80710307819 100644
--- a/packages/docusaurus-plugin-content-docs/src/client/__tests__/docsClientUtils.test.ts
+++ b/packages/docusaurus-plugin-content-docs/src/client/__tests__/docsClientUtils.test.ts
@@ -17,7 +17,7 @@ import type {
GlobalVersion,
ActivePlugin,
} from '@docusaurus/plugin-content-docs/client';
-import {shuffle} from 'lodash';
+import _ from 'lodash';
describe('docsClientUtils', () => {
test('getActivePlugin', () => {
@@ -227,7 +227,7 @@ describe('docsClientUtils', () => {
};
// shuffle, because order shouldn't matter
- const versions: GlobalVersion[] = shuffle([
+ const versions: GlobalVersion[] = _.shuffle([
versionNext,
version2,
version1,
@@ -356,7 +356,7 @@ describe('docsClientUtils', () => {
};
// shuffle, because order shouldn't matter
- const versions: GlobalVersion[] = shuffle([
+ const versions: GlobalVersion[] = _.shuffle([
versionNext,
version2,
version1,
diff --git a/packages/docusaurus-plugin-content-docs/src/docs.ts b/packages/docusaurus-plugin-content-docs/src/docs.ts
index 79f692b16931..b58c4c235378 100644
--- a/packages/docusaurus-plugin-content-docs/src/docs.ts
+++ b/packages/docusaurus-plugin-content-docs/src/docs.ts
@@ -8,7 +8,6 @@
import path from 'path';
import fs from 'fs-extra';
import logger from '@docusaurus/logger';
-import {keyBy} from 'lodash';
import {
aliasedSitePath,
getEditUrl,
@@ -276,9 +275,9 @@ export function processDocMetadata(args: {
}): DocMetadataBase {
try {
return doProcessDocMetadata(args);
- } catch (e) {
+ } catch (err) {
logger.error`Can't process doc metadata for doc at path path=${args.docFile.filePath} in version name=${args.versionMetadata.versionName}`;
- throw e;
+ throw err;
}
}
@@ -364,7 +363,7 @@ export function getMainDocId({
doc.unversionedId === firstDocIdOfFirstSidebar,
)!;
}
- return docs[0];
+ return docs[0]!;
}
return getMainDoc().unversionedId;
@@ -444,8 +443,10 @@ export function getDocIds(doc: DocMetadataBase): [string, string] {
export function createDocsByIdIndex<
Doc extends {id: string; unversionedId: string},
>(docs: Doc[]): Record {
- return {
- ...keyBy(docs, (doc) => doc.unversionedId),
- ...keyBy(docs, (doc) => doc.id),
- };
+ return Object.fromEntries(
+ docs.flatMap((doc) => [
+ [doc.unversionedId, doc],
+ [doc.id, doc],
+ ]),
+ );
}
diff --git a/packages/docusaurus-plugin-content-docs/src/globalData.ts b/packages/docusaurus-plugin-content-docs/src/globalData.ts
index c97feb340c0d..9939fb7fca90 100644
--- a/packages/docusaurus-plugin-content-docs/src/globalData.ts
+++ b/packages/docusaurus-plugin-content-docs/src/globalData.ts
@@ -5,7 +5,7 @@
* LICENSE file in the root directory of this source tree.
*/
-import {mapValues} from 'lodash';
+import _ from 'lodash';
import {normalizeUrl} from '@docusaurus/utils';
import type {Sidebars} from './sidebars/types';
import {createSidebarsUtils} from './sidebars/utils';
@@ -43,7 +43,7 @@ export function toGlobalSidebars(
version: LoadedVersion,
): Record {
const {getFirstLink} = createSidebarsUtils(sidebars);
- return mapValues(sidebars, (sidebar, sidebarId) => {
+ return _.mapValues(sidebars, (sidebar, sidebarId) => {
const firstLink = getFirstLink(sidebarId);
if (!firstLink) {
return {};
diff --git a/packages/docusaurus-plugin-content-docs/src/index.ts b/packages/docusaurus-plugin-content-docs/src/index.ts
index 9aeac134bdd9..4e6d19f4bcad 100644
--- a/packages/docusaurus-plugin-content-docs/src/index.ts
+++ b/packages/docusaurus-plugin-content-docs/src/index.ts
@@ -38,11 +38,11 @@ import type {
DocFile,
DocsMarkdownOption,
VersionTag,
+ DocFrontMatter,
} from './types';
import type {RuleSetRule} from 'webpack';
import {cliDocsVersionCommand} from './cli';
import {VERSIONS_JSON_FILE} from './constants';
-import {keyBy, mapValues} from 'lodash';
import {toGlobalDataVersion} from './globalData';
import {toTagDocListProp} from './props';
import {
@@ -196,9 +196,9 @@ export default async function pluginContentDocs(
async function loadVersion(versionMetadata: VersionMetadata) {
try {
return await doLoadVersion(versionMetadata);
- } catch (e) {
+ } catch (err) {
logger.error`Loading of version failed for version name=${versionMetadata.versionName}`;
- throw e;
+ throw err;
}
}
@@ -311,9 +311,8 @@ export default async function pluginContentDocs(
function getSourceToPermalink(): SourceToPermalink {
const allDocs = content.loadedVersions.flatMap((v) => v.docs);
- return mapValues(
- keyBy(allDocs, (d) => d.source),
- (d) => d.permalink,
+ return Object.fromEntries(
+ allDocs.map(({source, permalink}) => [source, permalink]),
);
}
@@ -362,6 +361,15 @@ export default async function pluginContentDocs(
const aliasedPath = aliasedSitePath(mdxPath, siteDir);
return path.join(dataDir, `${docuHash(aliasedPath)}.json`);
},
+ // Assets allow to convert some relative images paths to
+ // require(...) calls
+ createAssets: ({
+ frontMatter,
+ }: {
+ frontMatter: DocFrontMatter;
+ }) => ({
+ image: frontMatter.image,
+ }),
},
},
{
diff --git a/packages/docusaurus-plugin-content-docs/src/lastUpdate.ts b/packages/docusaurus-plugin-content-docs/src/lastUpdate.ts
index 9114bb3d9ec7..e62cfe309360 100644
--- a/packages/docusaurus-plugin-content-docs/src/lastUpdate.ts
+++ b/packages/docusaurus-plugin-content-docs/src/lastUpdate.ts
@@ -27,12 +27,12 @@ export async function getFileLastUpdate(
includeAuthor: true,
});
return {timestamp: result.timestamp, author: result.author};
- } catch (e) {
- if (e instanceof GitNotFoundError && !showedGitRequirementError) {
+ } catch (err) {
+ if (err instanceof GitNotFoundError && !showedGitRequirementError) {
logger.warn('Sorry, the docs plugin last update options require Git.');
showedGitRequirementError = true;
} else {
- logger.error(e);
+ logger.error(err);
}
return null;
}
diff --git a/packages/docusaurus-plugin-content-docs/src/markdown/__tests__/linkify.test.ts b/packages/docusaurus-plugin-content-docs/src/markdown/__tests__/linkify.test.ts
index 56dc2cc9e9a8..79c2fc91f58c 100644
--- a/packages/docusaurus-plugin-content-docs/src/markdown/__tests__/linkify.test.ts
+++ b/packages/docusaurus-plugin-content-docs/src/markdown/__tests__/linkify.test.ts
@@ -89,23 +89,26 @@ function createMarkdownOptions(
};
}
-const transform = (filepath: string, options?: Partial) => {
+const transform = async (
+ filepath: string,
+ options?: Partial,
+) => {
const markdownOptions = createMarkdownOptions(options);
- const content = fs.readFileSync(filepath, 'utf-8');
+ const content = await fs.readFile(filepath, 'utf-8');
const transformedContent = linkify(content, filepath, markdownOptions);
return [content, transformedContent];
};
-test('transform nothing', () => {
+test('transform nothing', async () => {
const doc1 = path.join(versionCurrent.contentPath, 'doc1.md');
- const [content, transformedContent] = transform(doc1);
+ const [content, transformedContent] = await transform(doc1);
expect(transformedContent).toMatchSnapshot();
expect(content).toEqual(transformedContent);
});
-test('transform to correct links', () => {
+test('transform to correct links', async () => {
const doc2 = path.join(versionCurrent.contentPath, 'doc2.md');
- const [content, transformedContent] = transform(doc2);
+ const [content, transformedContent] = await transform(doc2);
expect(transformedContent).toMatchSnapshot();
expect(transformedContent).toContain('](/docs/doc1');
expect(transformedContent).toContain('](/docs/doc2');
@@ -118,19 +121,19 @@ test('transform to correct links', () => {
expect(content).not.toEqual(transformedContent);
});
-test('transform relative links', () => {
+test('transform relative links', async () => {
const doc3 = path.join(versionCurrent.contentPath, 'subdir', 'doc3.md');
- const [content, transformedContent] = transform(doc3);
+ const [content, transformedContent] = await transform(doc3);
expect(transformedContent).toMatchSnapshot();
expect(transformedContent).toContain('](/docs/doc2');
expect(transformedContent).not.toContain('](../doc2.md)');
expect(content).not.toEqual(transformedContent);
});
-test('transforms reference links', () => {
+test('transforms reference links', async () => {
const doc4 = path.join(versionCurrent.contentPath, 'doc4.md');
- const [content, transformedContent] = transform(doc4);
+ const [content, transformedContent] = await transform(doc4);
expect(transformedContent).toMatchSnapshot();
expect(transformedContent).toContain('[doc1]: /docs/doc1');
expect(transformedContent).toContain('[doc2]: /docs/doc2');
@@ -139,10 +142,10 @@ test('transforms reference links', () => {
expect(content).not.toEqual(transformedContent);
});
-test('report broken markdown links', () => {
+test('report broken markdown links', async () => {
const doc5 = path.join(versionCurrent.contentPath, 'doc5.md');
const onBrokenMarkdownLink = jest.fn();
- const [content, transformedContent] = transform(doc5, {
+ const [content, transformedContent] = await transform(doc5, {
onBrokenMarkdownLink,
});
expect(transformedContent).toEqual(content);
@@ -169,9 +172,9 @@ test('report broken markdown links', () => {
} as BrokenMarkdownLink);
});
-test('transforms absolute links in versioned docs', () => {
+test('transforms absolute links in versioned docs', async () => {
const doc2 = path.join(version100.contentPath, 'doc2.md');
- const [content, transformedContent] = transform(doc2);
+ const [content, transformedContent] = await transform(doc2);
expect(transformedContent).toMatchSnapshot();
expect(transformedContent).toContain('](/docs/1.0.0/subdir/doc1');
expect(transformedContent).toContain('](/docs/1.0.0/doc2#existing-docs');
@@ -180,9 +183,9 @@ test('transforms absolute links in versioned docs', () => {
expect(content).not.toEqual(transformedContent);
});
-test('transforms relative links in versioned docs', () => {
+test('transforms relative links in versioned docs', async () => {
const doc1 = path.join(version100.contentPath, 'subdir', 'doc1.md');
- const [content, transformedContent] = transform(doc1);
+ const [content, transformedContent] = await transform(doc1);
expect(transformedContent).toMatchSnapshot();
expect(transformedContent).toContain('](/docs/1.0.0/doc2');
expect(transformedContent).not.toContain('](../doc2.md)');
diff --git a/packages/docusaurus-plugin-content-docs/src/plugin-content-docs.d.ts b/packages/docusaurus-plugin-content-docs/src/plugin-content-docs.d.ts
index 00c4e8fda250..95ec7b3635a3 100644
--- a/packages/docusaurus-plugin-content-docs/src/plugin-content-docs.d.ts
+++ b/packages/docusaurus-plugin-content-docs/src/plugin-content-docs.d.ts
@@ -8,6 +8,10 @@
declare module '@docusaurus/plugin-content-docs' {
import type {RemarkAndRehypePluginOptions} from '@docusaurus/mdx-loader';
+ export interface Assets {
+ image?: string;
+ }
+
export type NumberPrefixParser = (filename: string) => {
filename: string;
numberPrefix?: number;
@@ -159,6 +163,7 @@ declare module '@theme/DocItem' {
import type {
PropNavigationLink,
PropVersionMetadata,
+ Assets,
} from '@docusaurus/plugin-content-docs';
export type DocumentRoute = {
@@ -204,12 +209,12 @@ declare module '@theme/DocItem' {
readonly metadata: Metadata;
readonly toc: readonly TOCItem[];
readonly contentTitle: string | undefined;
+ readonly assets: Assets;
(): JSX.Element;
};
}
- const DocItem: (props: Props) => JSX.Element;
- export default DocItem;
+ export default function DocItem(props: Props): JSX.Element;
}
declare module '@theme/DocCategoryGeneratedIndexPage' {
@@ -258,8 +263,7 @@ declare module '@theme/DocPage' {
};
}
- const DocPage: (props: Props) => JSX.Element;
- export default DocPage;
+ export default function DocPage(props: Props): JSX.Element;
}
// TODO until TS supports exports field... hope it's in 4.6
diff --git a/packages/docusaurus-plugin-content-docs/src/props.ts b/packages/docusaurus-plugin-content-docs/src/props.ts
index c65efa9e47a4..0a99bf8f5b7a 100644
--- a/packages/docusaurus-plugin-content-docs/src/props.ts
+++ b/packages/docusaurus-plugin-content-docs/src/props.ts
@@ -22,7 +22,7 @@ import type {
PropTagDocListDoc,
PropSidebarItemLink,
} from '@docusaurus/plugin-content-docs';
-import {compact, keyBy, mapValues} from 'lodash';
+import _ from 'lodash';
import {createDocsByIdIndex} from './docs';
export function toSidebarsProp(loadedVersion: LoadedVersion): PropSidebars {
@@ -93,18 +93,22 @@ Available document ids are:
// Transform the sidebar so that all sidebar item will be in the
// form of 'link' or 'category' only.
// This is what will be passed as props to the UI component.
- return mapValues(loadedVersion.sidebars, (items) => items.map(normalizeItem));
+ return _.mapValues(loadedVersion.sidebars, (items) =>
+ items.map(normalizeItem),
+ );
}
function toVersionDocsProp(loadedVersion: LoadedVersion): PropVersionDocs {
- return mapValues(
- keyBy(loadedVersion.docs, (doc) => doc.unversionedId),
- (doc) => ({
- id: doc.unversionedId,
- title: doc.title,
- description: doc.description,
- sidebar: doc.sidebar,
- }),
+ return Object.fromEntries(
+ loadedVersion.docs.map((doc) => [
+ doc.unversionedId,
+ {
+ id: doc.unversionedId,
+ title: doc.title,
+ description: doc.description,
+ sidebar: doc.sidebar,
+ },
+ ]),
);
}
@@ -135,7 +139,7 @@ export function toTagDocListProp({
docs: Pick[];
}): PropTagDocList {
function toDocListProp(): PropTagDocListDoc[] {
- const list = compact(
+ const list = _.compact(
tag.docIds.map((id) => docs.find((doc) => doc.id === id)),
);
// Sort docs by title
diff --git a/packages/docusaurus-plugin-content-docs/src/routes.ts b/packages/docusaurus-plugin-content-docs/src/routes.ts
index e86b42f5718e..ad7608f449dc 100644
--- a/packages/docusaurus-plugin-content-docs/src/routes.ts
+++ b/packages/docusaurus-plugin-content-docs/src/routes.ts
@@ -178,8 +178,8 @@ export async function createVersionRoutes({
try {
return await doCreateVersionRoutes(loadedVersion);
- } catch (e) {
+ } catch (err) {
logger.error`Can't create version routes for version name=${loadedVersion.versionName}`;
- throw e;
+ throw err;
}
}
diff --git a/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/__fixtures__/sidebars/invalid-docs/foo/_category_.json b/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/__fixtures__/sidebars/invalid-docs/foo/_category_.json
new file mode 100644
index 000000000000..c8c4105eb57c
--- /dev/null
+++ b/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/__fixtures__/sidebars/invalid-docs/foo/_category_.json
@@ -0,0 +1,3 @@
+{
+ "foo": "bar"
+}
diff --git a/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/__fixtures__/sidebars/invalid-docs/foo/_category_.yml b/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/__fixtures__/sidebars/invalid-docs/foo/_category_.yml
new file mode 100644
index 000000000000..e69de29bb2d1
diff --git a/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/__snapshots__/generator.test.ts.snap b/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/__snapshots__/generator.test.ts.snap
new file mode 100644
index 000000000000..3338aa1cd534
--- /dev/null
+++ b/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/__snapshots__/generator.test.ts.snap
@@ -0,0 +1,255 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`DefaultSidebarItemsGenerator generates complex nested sidebar 1`] = `
+Array [
+ Object {
+ "id": "intro",
+ "type": "doc",
+ },
+ Object {
+ "collapsed": undefined,
+ "collapsible": undefined,
+ "items": Array [
+ Object {
+ "id": "tutorial1",
+ "type": "doc",
+ },
+ Object {
+ "id": "tutorial2",
+ "type": "doc",
+ },
+ ],
+ "label": "Tutorials",
+ "link": Object {
+ "id": "tutorials-index",
+ "type": "doc",
+ },
+ "type": "category",
+ },
+ Object {
+ "collapsed": false,
+ "collapsible": undefined,
+ "customProps": Object {
+ "description": "foo",
+ },
+ "items": Array [
+ Object {
+ "className": "foo",
+ "id": "guide1",
+ "type": "doc",
+ },
+ Object {
+ "collapsed": undefined,
+ "collapsible": undefined,
+ "items": Array [
+ Object {
+ "id": "nested-guide",
+ "type": "doc",
+ },
+ ],
+ "label": "SubGuides (metadata file label)",
+ "link": Object {
+ "description": "subguides-description",
+ "slug": "subguides-generated-index-slug",
+ "title": "subguides-title",
+ "type": "generated-index",
+ },
+ "type": "category",
+ },
+ Object {
+ "id": "guide2",
+ "type": "doc",
+ },
+ ],
+ "label": "Guides",
+ "link": Object {
+ "id": "guides-index",
+ "type": "doc",
+ },
+ "type": "category",
+ },
+ Object {
+ "id": "end",
+ "type": "doc",
+ },
+]
+`;
+
+exports[`DefaultSidebarItemsGenerator generates simple flat sidebar 1`] = `
+Array [
+ Object {
+ "id": "doc3",
+ "type": "doc",
+ },
+ Object {
+ "id": "doc4",
+ "type": "doc",
+ },
+ Object {
+ "id": "doc1",
+ "label": "doc1 sidebar label",
+ "type": "doc",
+ },
+ Object {
+ "id": "doc2",
+ "type": "doc",
+ },
+ Object {
+ "id": "doc5",
+ "type": "doc",
+ },
+]
+`;
+
+exports[`DefaultSidebarItemsGenerator generates subfolder sidebar 1`] = `
+Array [
+ Object {
+ "collapsed": undefined,
+ "collapsible": undefined,
+ "items": Array [
+ Object {
+ "id": "doc8",
+ "type": "doc",
+ },
+ Object {
+ "id": "doc7",
+ "type": "doc",
+ },
+ ],
+ "label": "subsubsubfolder3 (_category_.json label)",
+ "link": Object {
+ "id": "doc1",
+ "type": "doc",
+ },
+ "type": "category",
+ },
+ Object {
+ "className": "bar",
+ "collapsed": undefined,
+ "collapsible": undefined,
+ "items": Array [
+ Object {
+ "id": "doc6",
+ "type": "doc",
+ },
+ ],
+ "label": "subsubsubfolder2 (_category_.yml label)",
+ "type": "category",
+ },
+ Object {
+ "id": "doc1",
+ "type": "doc",
+ },
+ Object {
+ "id": "doc4",
+ "type": "doc",
+ },
+ Object {
+ "collapsed": undefined,
+ "collapsible": undefined,
+ "items": Array [
+ Object {
+ "id": "doc5",
+ "type": "doc",
+ },
+ ],
+ "label": "subsubsubfolder",
+ "type": "category",
+ },
+]
+`;
+
+exports[`DefaultSidebarItemsGenerator respects custom isCategoryIndex 1`] = `
+Array [
+ Object {
+ "id": "intro",
+ "type": "doc",
+ },
+ Object {
+ "collapsed": undefined,
+ "collapsible": undefined,
+ "items": Array [
+ Object {
+ "id": "tutorial1",
+ "type": "doc",
+ },
+ Object {
+ "id": "tutorial2",
+ "type": "doc",
+ },
+ ],
+ "label": "Tutorials",
+ "link": Object {
+ "id": "tutorials-index",
+ "type": "doc",
+ },
+ "type": "category",
+ },
+ Object {
+ "collapsed": undefined,
+ "collapsible": undefined,
+ "items": Array [
+ Object {
+ "className": "foo",
+ "id": "guide1",
+ "type": "doc",
+ },
+ Object {
+ "id": "guide2",
+ "type": "doc",
+ },
+ Object {
+ "id": "not-guides-index",
+ "type": "doc",
+ },
+ ],
+ "label": "Guides",
+ "type": "category",
+ },
+]
+`;
+
+exports[`DefaultSidebarItemsGenerator uses explicit link over the index/readme.{md,mdx} naming convention 1`] = `
+Array [
+ Object {
+ "collapsed": undefined,
+ "collapsible": undefined,
+ "items": Array [
+ Object {
+ "id": "parent/doc2",
+ "type": "doc",
+ },
+ Object {
+ "id": "parent/doc1",
+ "type": "doc",
+ },
+ ],
+ "label": "Category label",
+ "link": Object {
+ "id": "parent/doc3",
+ "type": "doc",
+ },
+ "type": "category",
+ },
+ Object {
+ "collapsed": undefined,
+ "collapsible": undefined,
+ "items": Array [
+ Object {
+ "id": "parent/doc4",
+ "type": "doc",
+ },
+ Object {
+ "id": "parent/doc6",
+ "type": "doc",
+ },
+ Object {
+ "id": "parent/doc5",
+ "type": "doc",
+ },
+ ],
+ "label": "Category 2 label",
+ "type": "category",
+ },
+]
+`;
diff --git a/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/generator.test.ts b/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/generator.test.ts
index dfda57ad8070..73c2357cd932 100644
--- a/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/generator.test.ts
+++ b/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/generator.test.ts
@@ -6,7 +6,7 @@
*/
import {DefaultSidebarItemsGenerator} from '../generator';
-import type {Sidebar, SidebarItemsGenerator} from '../types';
+import type {SidebarItemsGenerator} from '../types';
import {DefaultNumberPrefixParser} from '../../numberPrefix';
import {isCategoryIndex} from '../../docs';
@@ -104,13 +104,7 @@ describe('DefaultSidebarItemsGenerator', () => {
},
});
- expect(sidebarSlice).toEqual([
- {type: 'doc', id: 'doc3'},
- {type: 'doc', id: 'doc4'},
- {type: 'doc', id: 'doc1', label: 'doc1 sidebar label'},
- {type: 'doc', id: 'doc2'},
- {type: 'doc', id: 'doc5'},
- ] as Sidebar);
+ expect(sidebarSlice).toMatchSnapshot();
});
test('generates complex nested sidebar', async () => {
@@ -126,7 +120,12 @@ describe('DefaultSidebarItemsGenerator', () => {
contentPath: '',
},
categoriesMetadata: {
- '02-Guides': {collapsed: false},
+ '02-Guides': {
+ collapsed: false,
+ customProps: {
+ description: 'foo',
+ },
+ },
'02-Guides/01-SubGuides': {
label: 'SubGuides (metadata file label)',
link: {
@@ -142,7 +141,7 @@ describe('DefaultSidebarItemsGenerator', () => {
id: 'intro',
source: '@site/docs/intro.md',
sourceDirName: '.',
- sidebarPosition: 1,
+ sidebarPosition: 0,
frontMatter: {},
},
{
@@ -183,7 +182,7 @@ describe('DefaultSidebarItemsGenerator', () => {
id: 'guide1',
source: '@site/docs/02-Guides/guide1.md',
sourceDirName: '02-Guides',
- sidebarPosition: 1,
+ sidebarPosition: 0,
frontMatter: {
sidebar_class_name: 'foo',
},
@@ -209,46 +208,7 @@ describe('DefaultSidebarItemsGenerator', () => {
},
});
- expect(sidebarSlice).toEqual([
- {type: 'doc', id: 'intro'},
- {
- type: 'category',
- label: 'Tutorials',
- link: {
- type: 'doc',
- id: 'tutorials-index',
- },
- items: [
- {type: 'doc', id: 'tutorial1'},
- {type: 'doc', id: 'tutorial2'},
- ],
- },
- {
- type: 'category',
- label: 'Guides',
- link: {
- type: 'doc',
- id: 'guides-index',
- },
- collapsed: false,
- items: [
- {type: 'doc', id: 'guide1', className: 'foo'},
- {
- type: 'category',
- label: 'SubGuides (metadata file label)',
- items: [{type: 'doc', id: 'nested-guide'}],
- link: {
- type: 'generated-index',
- slug: 'subguides-generated-index-slug',
- title: 'subguides-title',
- description: 'subguides-description',
- },
- },
- {type: 'doc', id: 'guide2'},
- ],
- },
- {type: 'doc', id: 'end'},
- ] as Sidebar);
+ expect(sidebarSlice).toMatchSnapshot();
});
test('generates subfolder sidebar', async () => {
@@ -344,33 +304,7 @@ describe('DefaultSidebarItemsGenerator', () => {
},
});
- expect(sidebarSlice).toEqual([
- {
- type: 'category',
- label: 'subsubsubfolder3 (_category_.json label)',
- link: {
- id: 'doc1',
- type: 'doc',
- },
- items: [
- {type: 'doc', id: 'doc8'},
- {type: 'doc', id: 'doc7'},
- ],
- },
- {
- type: 'category',
- label: 'subsubsubfolder2 (_category_.yml label)',
- className: 'bar',
- items: [{type: 'doc', id: 'doc6'}],
- },
- {type: 'doc', id: 'doc1'},
- {type: 'doc', id: 'doc4'},
- {
- type: 'category',
- label: 'subsubsubfolder',
- items: [{type: 'doc', id: 'doc5'}],
- },
- ] as Sidebar);
+ expect(sidebarSlice).toMatchSnapshot();
});
test('uses explicit link over the index/readme.{md,mdx} naming convention', async () => {
@@ -406,7 +340,7 @@ describe('DefaultSidebarItemsGenerator', () => {
},
{
id: 'parent/doc2',
- source: '@site/docs/Category/index.md',
+ source: '@site/docs/Category/doc2.md',
sourceDirName: 'Category',
frontMatter: {},
},
@@ -441,44 +375,7 @@ describe('DefaultSidebarItemsGenerator', () => {
},
});
- expect(sidebarSlice).toEqual([
- {
- type: 'category',
- label: 'Category label',
- link: {
- id: 'parent/doc3',
- type: 'doc',
- },
- items: [
- {
- id: 'parent/doc1',
- type: 'doc',
- },
- {
- id: 'parent/doc2',
- type: 'doc',
- },
- ],
- },
- {
- type: 'category',
- label: 'Category 2 label',
- items: [
- {
- id: 'parent/doc4',
- type: 'doc',
- },
- {
- id: 'parent/doc5',
- type: 'doc',
- },
- {
- id: 'parent/doc6',
- type: 'doc',
- },
- ],
- },
- ] as Sidebar);
+ expect(sidebarSlice).toMatchSnapshot();
});
test('respects custom isCategoryIndex', async () => {
@@ -508,7 +405,7 @@ describe('DefaultSidebarItemsGenerator', () => {
id: 'intro',
source: '@site/docs/intro.md',
sourceDirName: '.',
- sidebarPosition: 1,
+ sidebarPosition: 0,
frontMatter: {},
},
{
@@ -561,32 +458,49 @@ describe('DefaultSidebarItemsGenerator', () => {
},
});
- expect(sidebarSlice).toEqual([
- {type: 'doc', id: 'intro'},
- {
- type: 'category',
- label: 'Tutorials',
- link: {
- type: 'doc',
- id: 'tutorials-index',
+ expect(sidebarSlice).toMatchSnapshot();
+ });
+
+ test('throws for unknown index link', async () => {
+ const generateSidebar = () =>
+ DefaultSidebarItemsGenerator({
+ numberPrefixParser: DefaultNumberPrefixParser,
+ isCategoryIndex,
+ item: {
+ type: 'autogenerated',
+ dirName: '.',
+ },
+ version: {
+ versionName: 'current',
+ contentPath: '',
+ },
+ categoriesMetadata: {
+ category: {
+ link: {
+ type: 'doc',
+ id: 'foo',
+ },
+ },
},
- items: [
- {type: 'doc', id: 'tutorial1'},
- {type: 'doc', id: 'tutorial2'},
- ],
- },
- {
- type: 'category',
- label: 'Guides',
- items: [
- {type: 'doc', id: 'guide1', className: 'foo'},
- {type: 'doc', id: 'guide2'},
+ docs: [
{
- type: 'doc',
- id: 'not-guides-index',
+ id: 'intro',
+ unversionedId: 'intro',
+ source: '@site/docs/category/intro.md',
+ sourceDirName: 'category',
+ frontMatter: {},
},
],
- },
- ] as Sidebar);
+ options: {
+ sidebarCollapsed: true,
+ sidebarCollapsible: true,
+ },
+ });
+
+ await expect(generateSidebar).rejects.toThrowErrorMatchingInlineSnapshot(`
+ "Can't find any doc with ID foo.
+ Available doc IDs:
+ - intro"
+ `);
});
});
diff --git a/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/index.test.ts b/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/index.test.ts
index 8b259d8fcd6f..ad30c2177cec 100644
--- a/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/index.test.ts
+++ b/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/index.test.ts
@@ -23,7 +23,10 @@ describe('loadSidebars', () => {
frontMatter: {},
},
],
- version: {contentPath: 'docs/foo', contentPathLocalized: 'docs/foo'},
+ version: {
+ contentPath: path.join(fixtureDir, 'docs'),
+ contentPathLocalized: path.join(fixtureDir, 'docs'),
+ },
categoryLabelSlugger: null,
sidebarOptions: {sidebarCollapsed: true, sidebarCollapsible: true},
};
@@ -58,7 +61,7 @@ describe('loadSidebars', () => {
await expect(() =>
loadSidebars(sidebarPath, params),
).rejects.toThrowErrorMatchingInlineSnapshot(
- `"Invalid category {\\"type\\":\\"category\\",\\"label\\":\\"Category Label\\",\\"items\\":\\"doc1\\"}: items must be an array of sidebar items or a category shorthand"`,
+ `"Invalid sidebar items collection [36m\`\\"doc1\\"\`[39m in [36m\`items\`[39m of the category [34m[1mCategory Label[22m[39m: it must either be an array of sidebar items or a shorthand notation (which doesn't contain a [36m\`type\`[39m property). See [36m[4mhttps://docusaurus.io/docs/sidebar/items[24m[39m for all valid syntaxes."`,
);
});
@@ -107,4 +110,36 @@ describe('loadSidebars', () => {
const result = await loadSidebars(sidebarPath, params);
expect(result).toMatchSnapshot();
});
+
+ test('duplicate category metadata files', async () => {
+ const sidebarPath = path.join(
+ fixtureDir,
+ 'sidebars-collapsed-first-level.json',
+ );
+ const consoleWarnMock = jest
+ .spyOn(console, 'warn')
+ .mockImplementation(() => {});
+ const consoleErrorMock = jest
+ .spyOn(console, 'error')
+ .mockImplementation(() => {});
+ await expect(() =>
+ loadSidebars(sidebarPath, {
+ ...params,
+ version: {
+ contentPath: path.join(fixtureDir, 'invalid-docs'),
+ contentPathLocalized: path.join(fixtureDir, 'invalid-docs'),
+ },
+ }),
+ ).rejects.toThrowErrorMatchingInlineSnapshot(`"\\"foo\\" is not allowed"`);
+ expect(consoleWarnMock).toBeCalledWith(
+ expect.stringMatching(
+ /.*\[WARNING].* There are more than one category metadata files for .*foo.*: foo\/_category_.json, foo\/_category_.yml. The behavior is undetermined./,
+ ),
+ );
+ expect(consoleErrorMock).toBeCalledWith(
+ expect.stringMatching(
+ /.*\[ERROR].* The docs sidebar category metadata file .*foo\/_category_.json.* looks invalid!/,
+ ),
+ );
+ });
});
diff --git a/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/normalization.test.ts b/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/normalization.test.ts
index 23234b60deeb..fbb00ec825ae 100644
--- a/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/normalization.test.ts
+++ b/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/normalization.test.ts
@@ -37,4 +37,53 @@ describe('normalization', () => {
}),
).toMatchSnapshot();
});
+ test('rejects some invalid cases', () => {
+ expect(() =>
+ normalizeSidebars({
+ sidebar: {
+ Category: {type: 'autogenerated', dirName: 'foo'},
+ Category2: {type: 'autogenerated', dirName: 'bar'},
+ },
+ }),
+ ).toThrowErrorMatchingInlineSnapshot(
+ `"Invalid sidebar items collection [36m\`{\\"type\\":\\"autogenerated\\",\\"dirName\\":\\"foo\\"}\`[39m in [36m\`items\`[39m of the category [34m[1mCategory[22m[39m: it must either be an array of sidebar items or a shorthand notation (which doesn't contain a [36m\`type\`[39m property). See [36m[4mhttps://docusaurus.io/docs/sidebar/items[24m[39m for all valid syntaxes."`,
+ );
+
+ expect(() =>
+ normalizeSidebars({
+ sidebar: [
+ 'foo',
+ {
+ Category: {
+ type: 'category',
+ items: ['bar', 'baz'],
+ },
+ },
+ ],
+ }),
+ ).toThrowErrorMatchingInlineSnapshot(
+ `"Invalid sidebar items collection [36m\`{\\"type\\":\\"category\\",\\"items\\":[\\"bar\\",\\"baz\\"]}\`[39m in [36m\`items\`[39m of the category [34m[1mCategory[22m[39m: it must either be an array of sidebar items or a shorthand notation (which doesn't contain a [36m\`type\`[39m property). See [36m[4mhttps://docusaurus.io/docs/sidebar/items[24m[39m for all valid syntaxes."`,
+ );
+
+ expect(() =>
+ normalizeSidebars({
+ sidebar: [
+ 'foo',
+ {
+ Category: 'bar',
+ },
+ ],
+ }),
+ ).toThrowErrorMatchingInlineSnapshot(
+ `"Invalid sidebar items collection [36m\`\\"bar\\"\`[39m in [36m\`items\`[39m of the category [34m[1mCategory[22m[39m: it must either be an array of sidebar items or a shorthand notation (which doesn't contain a [36m\`type\`[39m property). See [36m[4mhttps://docusaurus.io/docs/sidebar/items[24m[39m for all valid syntaxes."`,
+ );
+
+ expect(() =>
+ normalizeSidebars({
+ sidebar: 'item',
+ }),
+ ).toThrowErrorMatchingInlineSnapshot(
+ `"Invalid sidebar items collection [36m\`\\"item\\"\`[39m in sidebar [34m[1msidebar[22m[39m: it must either be an array of sidebar items or a shorthand notation (which doesn't contain a [36m\`type\`[39m property). See [36m[4mhttps://docusaurus.io/docs/sidebar/items[24m[39m for all valid syntaxes."`,
+ );
+ });
});
diff --git a/packages/docusaurus-plugin-content-docs/src/sidebars/generator.ts b/packages/docusaurus-plugin-content-docs/src/sidebars/generator.ts
index 03239e3ec4a6..5e266bc00564 100644
--- a/packages/docusaurus-plugin-content-docs/src/sidebars/generator.ts
+++ b/packages/docusaurus-plugin-content-docs/src/sidebars/generator.ts
@@ -13,34 +13,36 @@ import type {
NormalizedSidebarItem,
SidebarItemCategoryLinkConfig,
} from './types';
-import {sortBy, last} from 'lodash';
+import _ from 'lodash';
import {addTrailingSlash, posixPath} from '@docusaurus/utils';
import logger from '@docusaurus/logger';
import path from 'path';
import {createDocsByIdIndex, toCategoryIndexMatcherParam} from '../docs';
const BreadcrumbSeparator = '/';
-// To avoid possible name clashes with a folder of the same name as the ID
-const docIdPrefix = '$doc$/';
// Just an alias to the make code more explicit
function getLocalDocId(docId: string): string {
- return last(docId.split('/'))!;
+ return _.last(docId.split('/'))!;
}
export const CategoryMetadataFilenameBase = '_category_';
export const CategoryMetadataFilenamePattern = '_category_.{json,yml,yaml}';
-type WithPosition = T & {position?: number};
+type WithPosition = T & {
+ position?: number;
+ /** The source is the file/folder name */
+ source?: string;
+};
/**
* A representation of the fs structure. For each object entry:
* If it's a folder, the key is the directory name, and value is the directory
- * content; If it's a doc file, the key is the doc id prefixed with '$doc$/',
- * and value is null
+ * content; If it's a doc file, the key is the doc's source file name, and value
+ * is the doc ID
*/
type Dir = {
- [item: string]: Dir | null;
+ [item: string]: Dir | string;
};
// Comment for this feature: https://github.com/facebook/docusaurus/issues/3464#issuecomment-818670449
@@ -58,9 +60,9 @@ export const DefaultSidebarItemsGenerator: SidebarItemsGenerator = async ({
const doc = findDoc(docId);
if (!doc) {
throw new Error(
- `Can't find any doc with id=${docId}.\nAvailable doc ids:\n- ${Object.keys(
- docsById,
- ).join('\n- ')}`,
+ `Can't find any doc with ID ${docId}.
+Available doc IDs:
+- ${Object.keys(docsById).join('\n- ')}`,
);
}
return doc;
@@ -108,14 +110,16 @@ export const DefaultSidebarItemsGenerator: SidebarItemsGenerator = async ({
const treeRoot: Dir = {};
docs.forEach((doc) => {
const breadcrumb = getRelativeBreadcrumb(doc);
- let currentDir = treeRoot; // We walk down the file's path to generate the fs structure
+ // We walk down the file's path to generate the fs structure
+ let currentDir = treeRoot;
breadcrumb.forEach((dir) => {
if (typeof currentDir[dir] === 'undefined') {
currentDir[dir] = {}; // Create new folder.
}
- currentDir = currentDir[dir]!; // Go into the subdirectory.
+ currentDir = currentDir[dir] as Dir; // Go into the subdirectory.
});
- currentDir[`${docIdPrefix}${doc.id}`] = null; // We've walked through the file path. Register the file in this directory.
+ // We've walked through the path. Register the file in this directory.
+ currentDir[path.basename(doc.source)] = doc.id;
});
return treeRoot;
}
@@ -126,8 +130,12 @@ export const DefaultSidebarItemsGenerator: SidebarItemsGenerator = async ({
*/
function generateSidebar(
fsModel: Dir,
- ): Promise[]> {
- function createDocItem(id: string): WithPosition {
+ ): WithPosition[] {
+ function createDocItem(
+ id: string,
+ fullPath: string,
+ fileName: string,
+ ): WithPosition {
const {
sidebarPosition: position,
frontMatter: {sidebar_label: label, sidebar_class_name: className},
@@ -136,25 +144,25 @@ export const DefaultSidebarItemsGenerator: SidebarItemsGenerator = async ({
type: 'doc',
id,
position,
+ source: fileName,
// We don't want these fields to magically appear in the generated
// sidebar
...(label !== undefined && {label}),
...(className !== undefined && {className}),
};
}
- async function createCategoryItem(
+ function createCategoryItem(
dir: Dir,
fullPath: string,
folderName: string,
- ): Promise> {
+ ): WithPosition {
const categoryMetadata =
categoriesMetadata[posixPath(path.join(autogenDir, fullPath))];
const className = categoryMetadata?.className;
+ const customProps = categoryMetadata?.customProps;
const {filename, numberPrefix} = numberPrefixParser(folderName);
- const allItems = await Promise.all(
- Object.entries(dir).map(([key, content]) =>
- dirToItem(content, key, `${fullPath}/${key}`),
- ),
+ const allItems = Object.entries(dir).map(([key, content]) =>
+ dirToItem(content, key, `${fullPath}/${key}`),
);
// Try to match a doc inside the category folder,
@@ -211,24 +219,24 @@ export const DefaultSidebarItemsGenerator: SidebarItemsGenerator = async ({
collapsible: categoryMetadata?.collapsible,
collapsed: categoryMetadata?.collapsed,
position: categoryMetadata?.position ?? numberPrefix,
+ source: folderName,
+ ...(customProps !== undefined && {customProps}),
...(className !== undefined && {className}),
items,
...(link && {link}),
};
}
- async function dirToItem(
- dir: Dir | null, // The directory item to be transformed.
- itemKey: string, // For docs, it's the doc ID; for categories, it's used to generate the next `relativePath`.
+ function dirToItem(
+ dir: Dir | string, // The directory item to be transformed.
+ itemKey: string, // File/folder name; for categories, it's used to generate the next `relativePath`.
fullPath: string, // `dir`'s full path relative to the autogen dir.
- ): Promise> {
- return dir
+ ): WithPosition {
+ return typeof dir === 'object'
? createCategoryItem(dir, fullPath, itemKey)
- : createDocItem(itemKey.substring(docIdPrefix.length));
+ : createDocItem(dir, fullPath, itemKey);
}
- return Promise.all(
- Object.entries(fsModel).map(([key, content]) =>
- dirToItem(content, key, key),
- ),
+ return Object.entries(fsModel).map(([key, content]) =>
+ dirToItem(content, key, key),
);
}
@@ -248,16 +256,16 @@ export const DefaultSidebarItemsGenerator: SidebarItemsGenerator = async ({
}
return item;
});
- const sortedSidebarItems = sortBy(
- processedSidebarItems,
- (item) => item.position,
- );
- return sortedSidebarItems.map(({position, ...item}) => item);
+ const sortedSidebarItems = _.sortBy(processedSidebarItems, [
+ 'position',
+ 'source',
+ ]);
+ return sortedSidebarItems.map(({position, source, ...item}) => item);
}
// TODO: the whole code is designed for pipeline operator
const docs = getAutogenDocs();
const fsModel = treeify(docs);
- const sidebarWithPosition = await generateSidebar(fsModel);
+ const sidebarWithPosition = generateSidebar(fsModel);
const sortedSidebar = sortItems(sidebarWithPosition);
return sortedSidebar;
};
diff --git a/packages/docusaurus-plugin-content-docs/src/sidebars/index.ts b/packages/docusaurus-plugin-content-docs/src/sidebars/index.ts
index 2d095b209693..547a7bd5676e 100644
--- a/packages/docusaurus-plugin-content-docs/src/sidebars/index.ts
+++ b/packages/docusaurus-plugin-content-docs/src/sidebars/index.ts
@@ -17,7 +17,7 @@ import {Globby} from '@docusaurus/utils';
import logger from '@docusaurus/logger';
import type {PluginOptions} from '@docusaurus/plugin-content-docs';
import Yaml from 'js-yaml';
-import {groupBy, mapValues} from 'lodash';
+import _ from 'lodash';
import combinePromises from 'combine-promises';
export const DefaultSidebars: SidebarsConfig = {
@@ -46,10 +46,10 @@ async function readCategoriesMetadata(contentPath: string) {
const categoryFiles = await Globby('**/_category_.{json,yml,yaml}', {
cwd: contentPath,
});
- const categoryToFile = groupBy(categoryFiles, path.dirname);
+ const categoryToFile = _.groupBy(categoryFiles, path.dirname);
return combinePromises(
- mapValues(categoryToFile, async (files, folder) => {
- const [filePath] = files;
+ _.mapValues(categoryToFile, async (files, folder) => {
+ const filePath = files[0]!;
if (files.length > 1) {
logger.warn`There are more than one category metadata files for path=${folder}: ${files.join(
', ',
@@ -61,9 +61,9 @@ async function readCategoriesMetadata(contentPath: string) {
);
try {
return validateCategoryMetadataFile(Yaml.load(content));
- } catch (e) {
+ } catch (err) {
logger.error`The docs sidebar category metadata file path=${filePath} looks invalid!`;
- throw e;
+ throw err;
}
}),
);
@@ -85,7 +85,7 @@ export async function loadSidebarsFileUnsafe(
// Non-existent sidebars file: no sidebars
// Note: this edge case can happen on versioned docs, not current version
// We avoid creating empty versioned sidebars file with the CLI
- if (!fs.existsSync(sidebarFilePath)) {
+ if (!(await fs.pathExists(sidebarFilePath))) {
return DisabledSidebars;
}
diff --git a/packages/docusaurus-plugin-content-docs/src/sidebars/normalization.ts b/packages/docusaurus-plugin-content-docs/src/sidebars/normalization.ts
index 60c7b8040587..dad431fbd172 100644
--- a/packages/docusaurus-plugin-content-docs/src/sidebars/normalization.ts
+++ b/packages/docusaurus-plugin-content-docs/src/sidebars/normalization.ts
@@ -17,7 +17,8 @@ import type {
NormalizedSidebarItemCategory,
} from './types';
import {isCategoriesShorthand} from './utils';
-import {mapValues} from 'lodash';
+import _ from 'lodash';
+import logger from '@docusaurus/logger';
function normalizeCategoriesShorthand(
sidebar: SidebarCategoriesShorthand,
@@ -37,40 +38,37 @@ export function normalizeItem(
item: SidebarItemConfig,
): NormalizedSidebarItem[] {
if (typeof item === 'string') {
- return [
- {
- type: 'doc',
- id: item,
- },
- ];
+ return [{type: 'doc', id: item}];
}
if (isCategoriesShorthand(item)) {
- return normalizeCategoriesShorthand(item).flatMap((subItem) =>
- normalizeItem(subItem),
- );
+ // This will never throw anyways
+ return normalizeSidebar(item, 'sidebar items slice');
}
if (item.type === 'category') {
- if (typeof item.items !== 'undefined' && typeof item.items !== 'object') {
- throw new Error(
- `Invalid category ${JSON.stringify(
- item,
- )}: items must be an array of sidebar items or a category shorthand`,
- );
- }
const normalizedCategory: NormalizedSidebarItemCategory = {
...item,
- items: Array.isArray(item.items)
- ? item.items.flatMap((subItem) => normalizeItem(subItem))
- : normalizeCategoriesShorthand(item.items).flatMap((subItem) =>
- normalizeItem(subItem),
- ),
+ items: normalizeSidebar(
+ item.items,
+ logger.interpolate`code=${'items'} of the category name=${item.label}`,
+ ),
};
return [normalizedCategory];
}
return [item];
}
-function normalizeSidebar(sidebar: SidebarConfig): NormalizedSidebar {
+function normalizeSidebar(
+ sidebar: SidebarConfig,
+ place: string,
+): NormalizedSidebar {
+ if (!Array.isArray(sidebar) && !isCategoriesShorthand(sidebar)) {
+ throw new Error(
+ logger.interpolate`Invalid sidebar items collection code=${JSON.stringify(
+ sidebar,
+ )} in ${place}: it must either be an array of sidebar items or a shorthand notation (which doesn't contain a code=${'type'} property). See path=${'https://docusaurus.io/docs/sidebar/items'} for all valid syntaxes.`,
+ );
+ }
+
const normalizedSidebar = Array.isArray(sidebar)
? sidebar
: normalizeCategoriesShorthand(sidebar);
@@ -81,5 +79,7 @@ function normalizeSidebar(sidebar: SidebarConfig): NormalizedSidebar {
export function normalizeSidebars(
sidebars: SidebarsConfig,
): NormalizedSidebars {
- return mapValues(sidebars, normalizeSidebar);
+ return _.mapValues(sidebars, (sidebar, id) =>
+ normalizeSidebar(sidebar, logger.interpolate`sidebar name=${id}`),
+ );
}
diff --git a/packages/docusaurus-plugin-content-docs/src/sidebars/postProcessor.ts b/packages/docusaurus-plugin-content-docs/src/sidebars/postProcessor.ts
index 7a30354ebd8d..48dafff60c63 100644
--- a/packages/docusaurus-plugin-content-docs/src/sidebars/postProcessor.ts
+++ b/packages/docusaurus-plugin-content-docs/src/sidebars/postProcessor.ts
@@ -15,7 +15,7 @@ import type {
ProcessedSidebars,
SidebarItemCategoryLink,
} from './types';
-import {mapValues} from 'lodash';
+import _ from 'lodash';
function normalizeCategoryLink(
category: ProcessedSidebarItemCategory,
@@ -88,7 +88,7 @@ export function postProcessSidebars(
sidebars: ProcessedSidebars,
params: SidebarProcessorParams,
): Sidebars {
- return mapValues(sidebars, (sidebar) =>
+ return _.mapValues(sidebars, (sidebar) =>
sidebar.map((item) => postProcessSidebarItem(item, params)),
);
}
diff --git a/packages/docusaurus-plugin-content-docs/src/sidebars/processor.ts b/packages/docusaurus-plugin-content-docs/src/sidebars/processor.ts
index f7432222e448..6f99428f6e29 100644
--- a/packages/docusaurus-plugin-content-docs/src/sidebars/processor.ts
+++ b/packages/docusaurus-plugin-content-docs/src/sidebars/processor.ts
@@ -21,14 +21,14 @@ import type {
} from './types';
import {DefaultSidebarItemsGenerator} from './generator';
import {validateSidebars} from './validation';
-import {mapValues, memoize, pick} from 'lodash';
+import _ from 'lodash';
import combinePromises from 'combine-promises';
import {isCategoryIndex} from '../docs';
function toSidebarItemsGeneratorDoc(
doc: DocMetadataBase,
): SidebarItemsGeneratorDoc {
- return pick(doc, [
+ return _.pick(doc, [
'id',
'unversionedId',
'frontMatter',
@@ -41,7 +41,7 @@ function toSidebarItemsGeneratorDoc(
function toSidebarItemsGeneratorVersion(
version: VersionMetadata,
): SidebarItemsGeneratorVersion {
- return pick(version, ['versionName', 'contentPath']);
+ return _.pick(version, ['versionName', 'contentPath']);
}
// Handle the generation of autogenerated sidebar items and other
@@ -60,7 +60,7 @@ async function processSidebar(
} = params;
// Just a minor lazy transformation optimization
- const getSidebarItemsGeneratorDocsAndVersion = memoize(() => ({
+ const getSidebarItemsGeneratorDocsAndVersion = _.memoize(() => ({
docs: docs.map(toSidebarItemsGeneratorDoc),
version: toSidebarItemsGeneratorVersion(version),
}));
@@ -117,7 +117,7 @@ export async function processSidebars(
params: SidebarProcessorParams,
): Promise {
const processedSidebars = await combinePromises(
- mapValues(unprocessedSidebars, (unprocessedSidebar) =>
+ _.mapValues(unprocessedSidebars, (unprocessedSidebar) =>
processSidebar(unprocessedSidebar, categoriesMetadata, params),
),
);
diff --git a/packages/docusaurus-plugin-content-docs/src/sidebars/types.ts b/packages/docusaurus-plugin-content-docs/src/sidebars/types.ts
index 914a854b6389..f9f6895ec96b 100644
--- a/packages/docusaurus-plugin-content-docs/src/sidebars/types.ts
+++ b/packages/docusaurus-plugin-content-docs/src/sidebars/types.ts
@@ -216,6 +216,7 @@ export type CategoryMetadataFile = {
collapsible?: boolean;
className?: string;
link?: SidebarItemCategoryLinkConfig | null;
+ customProps?: Record;
// TODO should we allow "items" here? how would this work? would an
// "autogenerated" type be allowed?
diff --git a/packages/docusaurus-plugin-content-docs/src/sidebars/utils.ts b/packages/docusaurus-plugin-content-docs/src/sidebars/utils.ts
index 8c172e55de78..20013e52085a 100644
--- a/packages/docusaurus-plugin-content-docs/src/sidebars/utils.ts
+++ b/packages/docusaurus-plugin-content-docs/src/sidebars/utils.ts
@@ -19,14 +19,14 @@ import type {
SidebarNavigationItem,
} from './types';
-import {mapValues, difference, uniq} from 'lodash';
+import _ from 'lodash';
import {getElementsAround, toMessageRelativeFilePath} from '@docusaurus/utils';
import type {DocMetadataBase, DocNavLink} from '../types';
export function isCategoriesShorthand(
item: SidebarItemConfig,
): item is SidebarCategoriesShorthand {
- return typeof item !== 'string' && !item.type;
+ return typeof item === 'object' && !item.type;
}
export function transformSidebarItems(
@@ -110,13 +110,13 @@ export function collectSidebarNavigation(
export function collectSidebarsDocIds(
sidebars: Sidebars,
): Record {
- return mapValues(sidebars, collectSidebarDocIds);
+ return _.mapValues(sidebars, collectSidebarDocIds);
}
export function collectSidebarsNavigations(
sidebars: Sidebars,
): Record {
- return mapValues(sidebars, collectSidebarNavigation);
+ return _.mapValues(sidebars, collectSidebarNavigation);
}
export type SidebarNavigation = {
@@ -201,12 +201,12 @@ export function createSidebarsUtils(sidebars: Sidebars): SidebarsUtils {
if (!sidebarName) {
return emptySidebarNavigation();
}
- if (!sidebarNameToNavigationItems[sidebarName]) {
+ const navigationItems = sidebarNameToNavigationItems[sidebarName];
+ if (!navigationItems) {
throw new Error(
`Doc with ID ${docId} wants to display sidebar ${sidebarName} but a sidebar with this name doesn't exist`,
);
}
- const navigationItems = sidebarNameToNavigationItems[sidebarName];
const currentItemIndex = navigationItems.findIndex((item) => {
if (item.type === 'doc') {
return item.id === docId;
@@ -258,12 +258,8 @@ export function createSidebarsUtils(sidebars: Sidebars): SidebarsUtils {
const sidebarName = Object.entries(sidebarNameToNavigationItems).find(
([, navigationItems]) =>
navigationItems.find(isCurrentCategoryGeneratedIndexItem),
- )?.[0];
-
- if (!sidebarName) {
- return emptySidebarNavigation();
- }
- const navigationItems = sidebarNameToNavigationItems[sidebarName];
+ )![0];
+ const navigationItems = sidebarNameToNavigationItems[sidebarName]!;
const currentItemIndex = navigationItems.findIndex(
isCurrentCategoryGeneratedIndexItem,
);
@@ -276,7 +272,7 @@ export function createSidebarsUtils(sidebars: Sidebars): SidebarsUtils {
function checkSidebarsDocIds(validDocIds: string[], sidebarFilePath: string) {
const allSidebarDocIds = Object.values(sidebarNameToDocIds).flat();
- const invalidSidebarDocIds = difference(allSidebarDocIds, validDocIds);
+ const invalidSidebarDocIds = _.difference(allSidebarDocIds, validDocIds);
if (invalidSidebarDocIds.length > 0) {
throw new Error(
`Invalid sidebar file at "${toMessageRelativeFilePath(
@@ -286,7 +282,7 @@ These sidebar document ids do not exist:
- ${invalidSidebarDocIds.sort().join('\n- ')}
Available document ids are:
-- ${uniq(validDocIds).sort().join('\n- ')}`,
+- ${_.uniq(validDocIds).sort().join('\n- ')}`,
);
}
}
@@ -341,7 +337,7 @@ Available document ids are:
getCategoryGeneratedIndexList,
getCategoryGeneratedIndexNavigation,
checkSidebarsDocIds,
- getFirstLink: (id) => getFirstLink(sidebars[id]),
+ getFirstLink: (id) => getFirstLink(sidebars[id]!),
};
}
diff --git a/packages/docusaurus-plugin-content-docs/src/sidebars/validation.ts b/packages/docusaurus-plugin-content-docs/src/sidebars/validation.ts
index 76dfb7ec1857..9ee2115e131c 100644
--- a/packages/docusaurus-plugin-content-docs/src/sidebars/validation.ts
+++ b/packages/docusaurus-plugin-content-docs/src/sidebars/validation.ts
@@ -164,6 +164,7 @@ const categoryMetadataFileSchema = Joi.object({
collapsible: Joi.boolean(),
className: Joi.string(),
link: sidebarItemCategoryLinkSchema,
+ customProps: Joi.object().unknown(),
});
export function validateCategoryMetadataFile(
diff --git a/packages/docusaurus-plugin-content-docs/src/tags.ts b/packages/docusaurus-plugin-content-docs/src/tags.ts
index 6d0c9a01f3ea..005b956bd804 100644
--- a/packages/docusaurus-plugin-content-docs/src/tags.ts
+++ b/packages/docusaurus-plugin-content-docs/src/tags.ts
@@ -7,11 +7,11 @@
import {groupTaggedItems} from '@docusaurus/utils';
import type {VersionTags, DocMetadata} from './types';
-import {mapValues} from 'lodash';
+import _ from 'lodash';
export function getVersionTags(docs: DocMetadata[]): VersionTags {
const groups = groupTaggedItems(docs, (doc) => doc.tags);
- return mapValues(groups, (group) => ({
+ return _.mapValues(groups, (group) => ({
name: group.tag.label,
docIds: group.items.map((item) => item.id),
permalink: group.tag.permalink,
diff --git a/packages/docusaurus-plugin-content-docs/src/translations.ts b/packages/docusaurus-plugin-content-docs/src/translations.ts
index d1d24172b72a..49681b01ea71 100644
--- a/packages/docusaurus-plugin-content-docs/src/translations.ts
+++ b/packages/docusaurus-plugin-content-docs/src/translations.ts
@@ -13,7 +13,7 @@ import type {
Sidebars,
} from './sidebars/types';
-import {chain, mapValues, keyBy} from 'lodash';
+import _ from 'lodash';
import {
collectSidebarCategories,
transformSidebarItems,
@@ -146,13 +146,15 @@ function getSidebarTranslationFileContent(
);
const links = collectSidebarLinks(sidebar);
- const linksContent: TranslationFileContent = chain(links)
- .keyBy((link) => `sidebar.${sidebarName}.link.${link.label}`)
- .mapValues((link) => ({
- message: link.label,
- description: `The label for link ${link.label} in sidebar ${sidebarName}, linking to ${link.href}`,
- }))
- .value();
+ const linksContent: TranslationFileContent = Object.fromEntries(
+ links.map((link) => [
+ `sidebar.${sidebarName}.link.${link.label}`,
+ {
+ message: link.label,
+ description: `The label for link ${link.label} in sidebar ${sidebarName}, linking to ${link.href}`,
+ },
+ ]),
+ );
return mergeTranslations([categoryContent, linksContent]);
}
@@ -230,7 +232,7 @@ function translateSidebars(
version: LoadedVersion,
sidebarsTranslations: TranslationFileContent,
): Sidebars {
- return mapValues(version.sidebars, (sidebar, sidebarName) =>
+ return _.mapValues(version.sidebars, (sidebar, sidebarName) =>
translateSidebar({
sidebar,
sidebarName: getNormalizedSidebarName({
@@ -272,10 +274,14 @@ function translateVersion(
translationFiles: Record,
): LoadedVersion {
const versionTranslations =
- translationFiles[getVersionFileName(version.versionName)].content;
+ translationFiles[getVersionFileName(version.versionName)]?.content;
+ if (!versionTranslations) {
+ return version;
+ }
return {
...version,
- versionLabel: versionTranslations['version.label']?.message,
+ versionLabel:
+ versionTranslations['version.label']?.message ?? version.versionLabel,
sidebars: translateSidebars(version, versionTranslations),
// docs: translateDocs(version.docs, versionTranslations),
};
@@ -302,7 +308,7 @@ export function translateLoadedContent(
loadedContent: LoadedContent,
translationFiles: TranslationFile[],
): LoadedContent {
- const translationFilesMap: Record = keyBy(
+ const translationFilesMap: Record = _.keyBy(
translationFiles,
(f) => f.path,
);
diff --git a/packages/docusaurus-plugin-content-docs/src/versions.ts b/packages/docusaurus-plugin-content-docs/src/versions.ts
index 18031cfa9c97..26fd63773c2a 100644
--- a/packages/docusaurus-plugin-content-docs/src/versions.ts
+++ b/packages/docusaurus-plugin-content-docs/src/versions.ts
@@ -28,7 +28,7 @@ import {
posixPath,
DEFAULT_PLUGIN_ID,
} from '@docusaurus/utils';
-import {difference} from 'lodash';
+import _ from 'lodash';
import {resolveSidebarPathOption} from './sidebars';
// retro-compatibility: no prefix for the default plugin id
@@ -418,7 +418,7 @@ function createVersionMetadata({
};
}
-function checkVersionMetadataPaths({
+async function checkVersionMetadataPaths({
versionMetadata,
context,
}: {
@@ -429,7 +429,7 @@ function checkVersionMetadataPaths({
const {siteDir} = context;
const isCurrentVersion = versionName === CURRENT_VERSION_NAME;
- if (!fs.existsSync(contentPath)) {
+ if (!(await fs.pathExists(contentPath))) {
throw new Error(
`The docs folder does not exist for version "${versionName}". A docs folder is expected to be found at ${path.relative(
siteDir,
@@ -446,7 +446,7 @@ function checkVersionMetadataPaths({
if (
isCurrentVersion &&
typeof sidebarFilePath === 'string' &&
- !fs.existsSync(sidebarFilePath)
+ !(await fs.pathExists(sidebarFilePath))
) {
throw new Error(`The path to the sidebar file does not exist at "${path.relative(
siteDir,
@@ -464,11 +464,11 @@ Please set the docs "sidebarPath" field in your config file to:
// "last version" is not a very good concept nor api surface
function getDefaultLastVersionName(versionNames: string[]) {
if (versionNames.length === 1) {
- return versionNames[0];
+ return versionNames[0]!;
}
return versionNames.filter(
(versionName) => versionName !== CURRENT_VERSION_NAME,
- )[0];
+ )[0]!;
}
function checkVersionsOptions(
@@ -486,7 +486,7 @@ function checkVersionsOptions(
`Docs option lastVersion: ${options.lastVersion} is invalid. ${availableVersionNamesMsg}`,
);
}
- const unknownVersionConfigNames = difference(
+ const unknownVersionConfigNames = _.difference(
Object.keys(options.versions),
availableVersionNames,
);
@@ -504,7 +504,7 @@ function checkVersionsOptions(
`Invalid docs option "onlyIncludeVersions": an empty array is not allowed, at least one version is needed.`,
);
}
- const unknownOnlyIncludeVersionNames = difference(
+ const unknownOnlyIncludeVersionNames = _.difference(
options.onlyIncludeVersions,
availableVersionNames,
);
@@ -585,8 +585,10 @@ export async function readVersionsMetadata({
options,
}),
);
- versionsMetadata.forEach((versionMetadata) =>
- checkVersionMetadataPaths({versionMetadata, context}),
+ await Promise.all(
+ versionsMetadata.map((versionMetadata) =>
+ checkVersionMetadataPaths({versionMetadata, context}),
+ ),
);
return versionsMetadata;
}
diff --git a/packages/docusaurus-plugin-content-pages/package.json b/packages/docusaurus-plugin-content-pages/package.json
index 4f452f507dba..612f0c90f35c 100644
--- a/packages/docusaurus-plugin-content-pages/package.json
+++ b/packages/docusaurus-plugin-content-pages/package.json
@@ -1,6 +1,6 @@
{
"name": "@docusaurus/plugin-content-pages",
- "version": "2.0.0-beta.15",
+ "version": "2.0.0-beta.17",
"description": "Pages plugin for Docusaurus.",
"main": "lib/index.js",
"types": "src/plugin-content-pages.d.ts",
@@ -18,17 +18,17 @@
},
"license": "MIT",
"dependencies": {
- "@docusaurus/core": "2.0.0-beta.15",
- "@docusaurus/mdx-loader": "2.0.0-beta.15",
- "@docusaurus/utils": "2.0.0-beta.15",
- "@docusaurus/utils-validation": "2.0.0-beta.15",
- "fs-extra": "^10.0.0",
+ "@docusaurus/core": "2.0.0-beta.17",
+ "@docusaurus/mdx-loader": "2.0.0-beta.17",
+ "@docusaurus/utils": "2.0.0-beta.17",
+ "@docusaurus/utils-validation": "2.0.0-beta.17",
+ "fs-extra": "^10.0.1",
"remark-admonitions": "^1.2.1",
"tslib": "^2.3.1",
- "webpack": "^5.68.0"
+ "webpack": "^5.69.1"
},
"devDependencies": {
- "@docusaurus/types": "2.0.0-beta.15"
+ "@docusaurus/types": "2.0.0-beta.17"
},
"peerDependencies": {
"react": "^16.8.4 || ^17.0.0",
diff --git a/packages/docusaurus-plugin-content-pages/src/plugin-content-pages.d.ts b/packages/docusaurus-plugin-content-pages/src/plugin-content-pages.d.ts
index e4991dea76ca..7993b6abdc7f 100644
--- a/packages/docusaurus-plugin-content-pages/src/plugin-content-pages.d.ts
+++ b/packages/docusaurus-plugin-content-pages/src/plugin-content-pages.d.ts
@@ -63,6 +63,5 @@ declare module '@theme/MDXPage' {
};
}
- const MDXPage: (props: Props) => JSX.Element;
- export default MDXPage;
+ export default function MDXPage(props: Props): JSX.Element;
}
diff --git a/packages/docusaurus-plugin-debug/package.json b/packages/docusaurus-plugin-debug/package.json
index 07dc85645174..bdcad0c78251 100644
--- a/packages/docusaurus-plugin-debug/package.json
+++ b/packages/docusaurus-plugin-debug/package.json
@@ -1,6 +1,6 @@
{
"name": "@docusaurus/plugin-debug",
- "version": "2.0.0-beta.15",
+ "version": "2.0.0-beta.17",
"description": "Debug plugin for Docusaurus.",
"main": "lib/index.js",
"types": "src/plugin-debug.d.ts",
@@ -18,14 +18,14 @@
},
"license": "MIT",
"dependencies": {
- "@docusaurus/core": "2.0.0-beta.15",
- "@docusaurus/utils": "2.0.0-beta.15",
- "fs-extra": "^10.0.0",
+ "@docusaurus/core": "2.0.0-beta.17",
+ "@docusaurus/utils": "2.0.0-beta.17",
+ "fs-extra": "^10.0.1",
"react-json-view": "^1.21.3",
"tslib": "^2.3.1"
},
"devDependencies": {
- "@docusaurus/types": "2.0.0-beta.15"
+ "@docusaurus/types": "2.0.0-beta.17"
},
"peerDependencies": {
"react": "^16.8.4 || ^17.0.0",
diff --git a/packages/docusaurus-plugin-debug/src/index.ts b/packages/docusaurus-plugin-debug/src/index.ts
index f85f3ba77238..0094918b4c4d 100644
--- a/packages/docusaurus-plugin-debug/src/index.ts
+++ b/packages/docusaurus-plugin-debug/src/index.ts
@@ -26,7 +26,6 @@ export default function pluginDebug({
getThemePath() {
return path.resolve(__dirname, '../lib/theme');
},
-
getTypeScriptThemePath() {
return path.resolve(__dirname, '../src/theme');
},
diff --git a/packages/docusaurus-plugin-debug/src/theme/DebugConfig/index.tsx b/packages/docusaurus-plugin-debug/src/theme/DebugConfig/index.tsx
index 7a233a4e38db..373fd530efff 100644
--- a/packages/docusaurus-plugin-debug/src/theme/DebugConfig/index.tsx
+++ b/packages/docusaurus-plugin-debug/src/theme/DebugConfig/index.tsx
@@ -12,7 +12,7 @@ import DebugJsonView from '@theme/DebugJsonView';
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
-function DebugMetadata(): JSX.Element {
+export default function DebugMetadata(): JSX.Element {
const {siteConfig} = useDocusaurusContext();
return (
@@ -21,5 +21,3 @@ function DebugMetadata(): JSX.Element {
);
}
-
-export default DebugMetadata;
diff --git a/packages/docusaurus-plugin-debug/src/theme/DebugContent/index.tsx b/packages/docusaurus-plugin-debug/src/theme/DebugContent/index.tsx
index 7c622b6a0124..122ede734cb2 100644
--- a/packages/docusaurus-plugin-debug/src/theme/DebugContent/index.tsx
+++ b/packages/docusaurus-plugin-debug/src/theme/DebugContent/index.tsx
@@ -54,7 +54,7 @@ function PluginContent({
);
}
-function DebugContent({allContent}: Props): JSX.Element {
+export default function DebugContent({allContent}: Props): JSX.Element {
return (
Plugin content
@@ -77,5 +77,3 @@ function DebugContent({allContent}: Props): JSX.Element {
);
}
-
-export default DebugContent;
diff --git a/packages/docusaurus-plugin-debug/src/theme/DebugGlobalData/index.tsx b/packages/docusaurus-plugin-debug/src/theme/DebugGlobalData/index.tsx
index 1f75152b9ee9..2a1b28b73fa8 100644
--- a/packages/docusaurus-plugin-debug/src/theme/DebugGlobalData/index.tsx
+++ b/packages/docusaurus-plugin-debug/src/theme/DebugGlobalData/index.tsx
@@ -11,7 +11,7 @@ import DebugLayout from '@theme/DebugLayout';
import DebugJsonView from '@theme/DebugJsonView';
import useGlobalData from '@docusaurus/useGlobalData';
-function DebugMetadata(): JSX.Element {
+export default function DebugMetadata(): JSX.Element {
const globalData = useGlobalData();
return (
@@ -20,5 +20,3 @@ function DebugMetadata(): JSX.Element {
);
}
-
-export default DebugMetadata;
diff --git a/packages/docusaurus-plugin-debug/src/theme/DebugJsonView/index.tsx b/packages/docusaurus-plugin-debug/src/theme/DebugJsonView/index.tsx
index eef8f994e430..783928cb7afc 100644
--- a/packages/docusaurus-plugin-debug/src/theme/DebugJsonView/index.tsx
+++ b/packages/docusaurus-plugin-debug/src/theme/DebugJsonView/index.tsx
@@ -27,7 +27,10 @@ function BrowserOnlyReactJson(props: ReactJsonViewProps) {
);
}
-function DebugJsonView({src, collapseDepth}: Props): JSX.Element {
+export default function DebugJsonView({
+ src,
+ collapseDepth,
+}: Props): JSX.Element {
return (
);
}
-
-export default DebugJsonView;
diff --git a/packages/docusaurus-plugin-debug/src/theme/DebugLayout/index.tsx b/packages/docusaurus-plugin-debug/src/theme/DebugLayout/index.tsx
index 53447eaaa80f..e8e57fde16de 100644
--- a/packages/docusaurus-plugin-debug/src/theme/DebugLayout/index.tsx
+++ b/packages/docusaurus-plugin-debug/src/theme/DebugLayout/index.tsx
@@ -25,7 +25,11 @@ function DebugNavLink({to, children}: {to: string; children: ReactNode}) {
);
}
-function DebugLayout({children}: {children: ReactNode}): JSX.Element {
+export default function DebugLayout({
+ children,
+}: {
+ children: ReactNode;
+}): JSX.Element {
return (
<>
@@ -53,5 +57,3 @@ function DebugLayout({children}: {children: ReactNode}): JSX.Element {
);
}
-
-export default DebugLayout;
diff --git a/packages/docusaurus-plugin-debug/src/theme/DebugRegistry/index.tsx b/packages/docusaurus-plugin-debug/src/theme/DebugRegistry/index.tsx
index 24e49ed027ec..0fc809149035 100644
--- a/packages/docusaurus-plugin-debug/src/theme/DebugRegistry/index.tsx
+++ b/packages/docusaurus-plugin-debug/src/theme/DebugRegistry/index.tsx
@@ -11,7 +11,7 @@ import DebugLayout from '@theme/DebugLayout';
import registry from '@generated/registry';
import styles from './styles.module.css';
-function DebugRegistry(): JSX.Element {
+export default function DebugRegistry(): JSX.Element {
return (
Registry
@@ -30,5 +30,3 @@ function DebugRegistry(): JSX.Element {
);
}
-
-export default DebugRegistry;
diff --git a/packages/docusaurus-plugin-debug/src/theme/DebugRoutes/index.tsx b/packages/docusaurus-plugin-debug/src/theme/DebugRoutes/index.tsx
index 0c8f37407ab5..962c9f508b06 100644
--- a/packages/docusaurus-plugin-debug/src/theme/DebugRoutes/index.tsx
+++ b/packages/docusaurus-plugin-debug/src/theme/DebugRoutes/index.tsx
@@ -12,7 +12,7 @@ import DebugJsonView from '@theme/DebugJsonView';
import routes from '@generated/routes';
import styles from './styles.module.css';
-function DebugRoutes(): JSX.Element {
+export default function DebugRoutes(): JSX.Element {
return (
Routes
@@ -37,5 +37,3 @@ function DebugRoutes(): JSX.Element {
);
}
-
-export default DebugRoutes;
diff --git a/packages/docusaurus-plugin-debug/src/theme/DebugSiteMetadata/index.tsx b/packages/docusaurus-plugin-debug/src/theme/DebugSiteMetadata/index.tsx
index b72b4484360e..934e45b97e9c 100644
--- a/packages/docusaurus-plugin-debug/src/theme/DebugSiteMetadata/index.tsx
+++ b/packages/docusaurus-plugin-debug/src/theme/DebugSiteMetadata/index.tsx
@@ -11,7 +11,7 @@ import DebugLayout from '@theme/DebugLayout';
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
import styles from './styles.module.css';
-function DebugMetadata(): JSX.Element {
+export default function DebugMetadata(): JSX.Element {
const {siteMetadata} = useDocusaurusContext();
return (
@@ -43,5 +43,3 @@ function DebugMetadata(): JSX.Element {
);
}
-
-export default DebugMetadata;
diff --git a/packages/docusaurus-plugin-google-analytics/package.json b/packages/docusaurus-plugin-google-analytics/package.json
index 691c3099fb0d..22799299275c 100644
--- a/packages/docusaurus-plugin-google-analytics/package.json
+++ b/packages/docusaurus-plugin-google-analytics/package.json
@@ -1,6 +1,6 @@
{
"name": "@docusaurus/plugin-google-analytics",
- "version": "2.0.0-beta.15",
+ "version": "2.0.0-beta.17",
"description": "Global analytics (analytics.js) plugin for Docusaurus.",
"main": "lib/index.js",
"types": "src/plugin-google-analytics.d.ts",
@@ -18,12 +18,12 @@
},
"license": "MIT",
"dependencies": {
- "@docusaurus/core": "2.0.0-beta.15",
- "@docusaurus/utils-validation": "2.0.0-beta.15",
+ "@docusaurus/core": "2.0.0-beta.17",
+ "@docusaurus/utils-validation": "2.0.0-beta.17",
"tslib": "^2.3.1"
},
"devDependencies": {
- "@docusaurus/types": "2.0.0-beta.15"
+ "@docusaurus/types": "2.0.0-beta.17"
},
"peerDependencies": {
"react": "^16.8.4 || ^17.0.0",
diff --git a/packages/docusaurus-plugin-google-gtag/package.json b/packages/docusaurus-plugin-google-gtag/package.json
index 21933fc5a7d5..72d03781ed89 100644
--- a/packages/docusaurus-plugin-google-gtag/package.json
+++ b/packages/docusaurus-plugin-google-gtag/package.json
@@ -1,6 +1,6 @@
{
"name": "@docusaurus/plugin-google-gtag",
- "version": "2.0.0-beta.15",
+ "version": "2.0.0-beta.17",
"description": "Global Site Tag (gtag.js) plugin for Docusaurus.",
"main": "lib/index.js",
"types": "src/plugin-google-gtag.d.ts",
@@ -18,12 +18,12 @@
},
"license": "MIT",
"dependencies": {
- "@docusaurus/core": "2.0.0-beta.15",
- "@docusaurus/utils-validation": "2.0.0-beta.15",
+ "@docusaurus/core": "2.0.0-beta.17",
+ "@docusaurus/utils-validation": "2.0.0-beta.17",
"tslib": "^2.3.1"
},
"devDependencies": {
- "@docusaurus/types": "2.0.0-beta.15"
+ "@docusaurus/types": "2.0.0-beta.17"
},
"peerDependencies": {
"react": "^16.8.4 || ^17.0.0",
diff --git a/packages/docusaurus-plugin-ideal-image/package.json b/packages/docusaurus-plugin-ideal-image/package.json
index ba48821274fa..06d71af4670d 100644
--- a/packages/docusaurus-plugin-ideal-image/package.json
+++ b/packages/docusaurus-plugin-ideal-image/package.json
@@ -1,6 +1,6 @@
{
"name": "@docusaurus/plugin-ideal-image",
- "version": "2.0.0-beta.15",
+ "version": "2.0.0-beta.17",
"description": "Docusaurus Plugin to generate an almost ideal image (responsive, lazy-loading, and low quality placeholder).",
"main": "lib/index.js",
"types": "src/plugin-ideal-image.d.ts",
@@ -21,21 +21,21 @@
},
"license": "MIT",
"dependencies": {
- "@docusaurus/core": "2.0.0-beta.15",
- "@docusaurus/lqip-loader": "2.0.0-beta.15",
- "@docusaurus/responsive-loader": "1.5.0",
- "@docusaurus/theme-translations": "2.0.0-beta.15",
- "@docusaurus/utils-validation": "2.0.0-beta.15",
+ "@docusaurus/core": "2.0.0-beta.17",
+ "@docusaurus/lqip-loader": "2.0.0-beta.17",
+ "@docusaurus/responsive-loader": "^1.7.0",
+ "@docusaurus/theme-translations": "2.0.0-beta.17",
+ "@docusaurus/utils-validation": "2.0.0-beta.17",
"@endiliey/react-ideal-image": "^0.0.11",
"react-waypoint": "^10.1.0",
"sharp": "^0.30.1",
"tslib": "^2.3.1",
- "webpack": "^5.68.0"
+ "webpack": "^5.69.1"
},
"devDependencies": {
- "@docusaurus/module-type-aliases": "2.0.0-beta.15",
- "@docusaurus/types": "2.0.0-beta.15",
- "fs-extra": "^10.0.0"
+ "@docusaurus/module-type-aliases": "2.0.0-beta.17",
+ "@docusaurus/types": "2.0.0-beta.17",
+ "fs-extra": "^10.0.1"
},
"peerDependencies": {
"jimp": "*",
diff --git a/packages/docusaurus-plugin-ideal-image/src/deps.d.ts b/packages/docusaurus-plugin-ideal-image/src/deps.d.ts
index 2adc3d7281cf..187065004d85 100644
--- a/packages/docusaurus-plugin-ideal-image/src/deps.d.ts
+++ b/packages/docusaurus-plugin-ideal-image/src/deps.d.ts
@@ -114,6 +114,5 @@ declare module '@endiliey/react-ideal-image' {
width: number;
}
- declare const IdealImage: (props: ImageProps) => JSX.Element;
- export default IdealImage;
+ export default function IdealImage(props: ImageProps): JSX.Element;
}
diff --git a/packages/docusaurus-plugin-ideal-image/src/index.ts b/packages/docusaurus-plugin-ideal-image/src/index.ts
index 39e5aa0be96f..1630f46e597d 100644
--- a/packages/docusaurus-plugin-ideal-image/src/index.ts
+++ b/packages/docusaurus-plugin-ideal-image/src/index.ts
@@ -56,7 +56,7 @@ export default function pluginIdealImage(
module: {
rules: [
{
- test: /\.(?:png|jpe?g|gif)$/i,
+ test: /\.(?:png|jpe?g)$/i,
use: [
require.resolve('@docusaurus/lqip-loader'),
{
diff --git a/packages/docusaurus-plugin-ideal-image/src/plugin-ideal-image.d.ts b/packages/docusaurus-plugin-ideal-image/src/plugin-ideal-image.d.ts
index c576246ebbd5..1435d0b1d4ce 100644
--- a/packages/docusaurus-plugin-ideal-image/src/plugin-ideal-image.d.ts
+++ b/packages/docusaurus-plugin-ideal-image/src/plugin-ideal-image.d.ts
@@ -66,8 +66,8 @@ declare module '@theme/IdealImage' {
images: SrcType[];
};
- export type Props = ComponentProps<'img'> & {
- img: {default: string} | {src: SrcImage; preSrc: string} | string;
- };
+ export interface Props extends ComponentProps<'img'> {
+ readonly img: {default: string} | {src: SrcImage; preSrc: string} | string;
+ }
export default function IdealImage(props: Props): JSX.Element;
}
diff --git a/packages/docusaurus-plugin-ideal-image/src/theme/IdealImage/index.tsx b/packages/docusaurus-plugin-ideal-image/src/theme/IdealImage/index.tsx
index 9e8fe9b1cd16..11f7da58f8c8 100644
--- a/packages/docusaurus-plugin-ideal-image/src/theme/IdealImage/index.tsx
+++ b/packages/docusaurus-plugin-ideal-image/src/theme/IdealImage/index.tsx
@@ -80,7 +80,7 @@ const getMessage = (icon: IconKey, state: State) => {
}
};
-function IdealImage(props: Props): JSX.Element {
+export default function IdealImage(props: Props): JSX.Element {
const {alt, className, img} = props;
// In dev env just use regular img with original file
@@ -112,5 +112,3 @@ function IdealImage(props: Props): JSX.Element {
/>
);
}
-
-export default IdealImage;
diff --git a/packages/docusaurus-plugin-pwa/package.json b/packages/docusaurus-plugin-pwa/package.json
index 4e77143a7908..ae781a7cd058 100644
--- a/packages/docusaurus-plugin-pwa/package.json
+++ b/packages/docusaurus-plugin-pwa/package.json
@@ -1,6 +1,6 @@
{
"name": "@docusaurus/plugin-pwa",
- "version": "2.0.0-beta.15",
+ "version": "2.0.0-beta.17",
"description": "Docusaurus Plugin to add PWA support.",
"main": "lib/index.js",
"types": "src/plugin-pwa.d.ts",
@@ -20,27 +20,27 @@
},
"license": "MIT",
"dependencies": {
- "@babel/core": "^7.17.2",
+ "@babel/core": "^7.17.5",
"@babel/preset-env": "^7.16.11",
- "@docusaurus/core": "2.0.0-beta.15",
- "@docusaurus/theme-common": "2.0.0-beta.15",
- "@docusaurus/theme-translations": "2.0.0-beta.15",
- "@docusaurus/utils": "2.0.0-beta.15",
- "@docusaurus/utils-validation": "2.0.0-beta.15",
+ "@docusaurus/core": "2.0.0-beta.17",
+ "@docusaurus/theme-common": "2.0.0-beta.17",
+ "@docusaurus/theme-translations": "2.0.0-beta.17",
+ "@docusaurus/utils": "2.0.0-beta.17",
+ "@docusaurus/utils-validation": "2.0.0-beta.17",
"babel-loader": "^8.2.3",
"clsx": "^1.1.1",
"core-js": "^3.21.0",
"terser-webpack-plugin": "^5.3.1",
"tslib": "^2.3.1",
- "webpack": "^5.68.0",
+ "webpack": "^5.69.1",
"webpack-merge": "^5.8.0",
- "workbox-build": "^6.4.2",
- "workbox-precaching": "^6.1.1",
- "workbox-window": "^6.4.2"
+ "workbox-build": "^6.5.0",
+ "workbox-precaching": "^6.5.0",
+ "workbox-window": "^6.5.0"
},
"devDependencies": {
- "@docusaurus/module-type-aliases": "2.0.0-beta.15",
- "fs-extra": "^10.0.0"
+ "@docusaurus/module-type-aliases": "2.0.0-beta.17",
+ "fs-extra": "^10.0.1"
},
"peerDependencies": {
"react": "^16.8.4 || ^17.0.0",
diff --git a/packages/docusaurus-plugin-pwa/src/index.ts b/packages/docusaurus-plugin-pwa/src/index.ts
index 8696d3dc0df6..e099ec0411bf 100644
--- a/packages/docusaurus-plugin-pwa/src/index.ts
+++ b/packages/docusaurus-plugin-pwa/src/index.ts
@@ -64,7 +64,10 @@ export default function pluginPWA(
name: 'docusaurus-plugin-pwa',
getThemePath() {
- return path.resolve(__dirname, './theme');
+ return path.resolve(__dirname, '../lib/theme');
+ },
+ getTypeScriptThemePath() {
+ return path.resolve(__dirname, '../src/theme');
},
getClientModules() {
diff --git a/packages/docusaurus-plugin-pwa/src/plugin-pwa.d.ts b/packages/docusaurus-plugin-pwa/src/plugin-pwa.d.ts
index 86786b48f185..94fe49d3503c 100644
--- a/packages/docusaurus-plugin-pwa/src/plugin-pwa.d.ts
+++ b/packages/docusaurus-plugin-pwa/src/plugin-pwa.d.ts
@@ -25,10 +25,8 @@ declare module '@docusaurus/plugin-pwa' {
}
declare module '@theme/PwaReloadPopup' {
- export type PwaReloadPopupProps = {
+ export interface Props {
readonly onReload: () => void;
- };
-
- const PwaReloadPopup: (props: PwaReloadPopupProps) => JSX.Element;
- export default PwaReloadPopup;
+ }
+ export default function PwaReloadPopup(props: Props): JSX.Element;
}
diff --git a/packages/docusaurus-plugin-pwa/src/theme/PwaReloadPopup/index.tsx b/packages/docusaurus-plugin-pwa/src/theme/PwaReloadPopup/index.tsx
index 5938859679fb..20e8490fb82b 100644
--- a/packages/docusaurus-plugin-pwa/src/theme/PwaReloadPopup/index.tsx
+++ b/packages/docusaurus-plugin-pwa/src/theme/PwaReloadPopup/index.tsx
@@ -9,11 +9,11 @@ import React, {useState} from 'react';
import clsx from 'clsx';
import Translate, {translate} from '@docusaurus/Translate';
-import type {PwaReloadPopupProps} from '@theme/PwaReloadPopup';
+import type {Props} from '@theme/PwaReloadPopup';
import styles from './styles.module.css';
-function PwaReloadPopup({onReload}: PwaReloadPopupProps): JSX.Element | false {
+export default function PwaReloadPopup({onReload}: Props): JSX.Element | false {
const [isVisible, setIsVisible] = useState(true);
return (
@@ -58,5 +58,3 @@ function PwaReloadPopup({onReload}: PwaReloadPopupProps): JSX.Element | false {
)
);
}
-
-export default PwaReloadPopup;
diff --git a/packages/docusaurus-plugin-sitemap/package.json b/packages/docusaurus-plugin-sitemap/package.json
index 8dce8f410448..fd186fa89048 100644
--- a/packages/docusaurus-plugin-sitemap/package.json
+++ b/packages/docusaurus-plugin-sitemap/package.json
@@ -1,6 +1,6 @@
{
"name": "@docusaurus/plugin-sitemap",
- "version": "2.0.0-beta.15",
+ "version": "2.0.0-beta.17",
"description": "Simple sitemap generation plugin for Docusaurus.",
"main": "lib/index.js",
"types": "src/plugin-sitemap.d.ts",
@@ -18,16 +18,16 @@
},
"license": "MIT",
"dependencies": {
- "@docusaurus/core": "2.0.0-beta.15",
- "@docusaurus/utils": "2.0.0-beta.15",
- "@docusaurus/utils-common": "2.0.0-beta.15",
- "@docusaurus/utils-validation": "2.0.0-beta.15",
- "fs-extra": "^10.0.0",
+ "@docusaurus/core": "2.0.0-beta.17",
+ "@docusaurus/utils": "2.0.0-beta.17",
+ "@docusaurus/utils-common": "2.0.0-beta.17",
+ "@docusaurus/utils-validation": "2.0.0-beta.17",
+ "fs-extra": "^10.0.1",
"sitemap": "^7.1.1",
"tslib": "^2.3.1"
},
"devDependencies": {
- "@docusaurus/types": "2.0.0-beta.15"
+ "@docusaurus/types": "2.0.0-beta.17"
},
"peerDependencies": {
"react": "^16.8.4 || ^17.0.0",
diff --git a/packages/docusaurus-preset-classic/package.json b/packages/docusaurus-preset-classic/package.json
index 1e87dcc106ae..59187fb486d3 100644
--- a/packages/docusaurus-preset-classic/package.json
+++ b/packages/docusaurus-preset-classic/package.json
@@ -1,6 +1,6 @@
{
"name": "@docusaurus/preset-classic",
- "version": "2.0.0-beta.15",
+ "version": "2.0.0-beta.17",
"description": "Classic preset for Docusaurus.",
"main": "lib/index.js",
"types": "src/preset-classic.d.ts",
@@ -18,17 +18,17 @@
},
"license": "MIT",
"dependencies": {
- "@docusaurus/core": "2.0.0-beta.15",
- "@docusaurus/plugin-content-blog": "2.0.0-beta.15",
- "@docusaurus/plugin-content-docs": "2.0.0-beta.15",
- "@docusaurus/plugin-content-pages": "2.0.0-beta.15",
- "@docusaurus/plugin-debug": "2.0.0-beta.15",
- "@docusaurus/plugin-google-analytics": "2.0.0-beta.15",
- "@docusaurus/plugin-google-gtag": "2.0.0-beta.15",
- "@docusaurus/plugin-sitemap": "2.0.0-beta.15",
- "@docusaurus/theme-classic": "2.0.0-beta.15",
- "@docusaurus/theme-common": "2.0.0-beta.15",
- "@docusaurus/theme-search-algolia": "2.0.0-beta.15"
+ "@docusaurus/core": "2.0.0-beta.17",
+ "@docusaurus/plugin-content-blog": "2.0.0-beta.17",
+ "@docusaurus/plugin-content-docs": "2.0.0-beta.17",
+ "@docusaurus/plugin-content-pages": "2.0.0-beta.17",
+ "@docusaurus/plugin-debug": "2.0.0-beta.17",
+ "@docusaurus/plugin-google-analytics": "2.0.0-beta.17",
+ "@docusaurus/plugin-google-gtag": "2.0.0-beta.17",
+ "@docusaurus/plugin-sitemap": "2.0.0-beta.17",
+ "@docusaurus/theme-classic": "2.0.0-beta.17",
+ "@docusaurus/theme-common": "2.0.0-beta.17",
+ "@docusaurus/theme-search-algolia": "2.0.0-beta.17"
},
"peerDependencies": {
"react": "^16.8.4 || ^17.0.0",
diff --git a/packages/docusaurus-remark-plugin-npm2yarn/package.json b/packages/docusaurus-remark-plugin-npm2yarn/package.json
index e43cbd4d7546..f183f95cafd6 100644
--- a/packages/docusaurus-remark-plugin-npm2yarn/package.json
+++ b/packages/docusaurus-remark-plugin-npm2yarn/package.json
@@ -1,6 +1,6 @@
{
"name": "@docusaurus/remark-plugin-npm2yarn",
- "version": "2.0.0-beta.15",
+ "version": "2.0.0-beta.17",
"description": "Remark plugin for converting npm commands to Yarn commands as tabs.",
"main": "lib/index.js",
"publishConfig": {
diff --git a/packages/docusaurus-remark-plugin-npm2yarn/src/index.ts b/packages/docusaurus-remark-plugin-npm2yarn/src/index.ts
index 7f80ed367824..b16949dd72e4 100644
--- a/packages/docusaurus-remark-plugin-npm2yarn/src/index.ts
+++ b/packages/docusaurus-remark-plugin-npm2yarn/src/index.ts
@@ -71,7 +71,7 @@ const plugin: Plugin<[PluginOptions?]> = (options = {}) => {
if (isParent(node)) {
let index = 0;
while (index < node.children.length) {
- const child = node.children[index];
+ const child = node.children[index]!;
if (matchNode(child)) {
const result = transformNode(child, sync);
node.children.splice(index, 1, ...result);
diff --git a/packages/docusaurus-theme-classic/package.json b/packages/docusaurus-theme-classic/package.json
index ef3745fb69f0..a55ea9e15f58 100644
--- a/packages/docusaurus-theme-classic/package.json
+++ b/packages/docusaurus-theme-classic/package.json
@@ -1,6 +1,6 @@
{
"name": "@docusaurus/theme-classic",
- "version": "2.0.0-beta.15",
+ "version": "2.0.0-beta.17",
"description": "Classic theme for Docusaurus",
"main": "lib/index.js",
"types": "src/theme-classic.d.ts",
@@ -21,34 +21,34 @@
"format:lib-next": "prettier --config ../../.prettierrc --write \"lib-next/**/*.{js,ts,jsx,tsc}\""
},
"dependencies": {
- "@docusaurus/core": "2.0.0-beta.15",
- "@docusaurus/plugin-content-blog": "2.0.0-beta.15",
- "@docusaurus/plugin-content-docs": "2.0.0-beta.15",
- "@docusaurus/plugin-content-pages": "2.0.0-beta.15",
- "@docusaurus/theme-common": "2.0.0-beta.15",
- "@docusaurus/theme-translations": "2.0.0-beta.15",
- "@docusaurus/utils": "2.0.0-beta.15",
- "@docusaurus/utils-common": "2.0.0-beta.15",
- "@docusaurus/utils-validation": "2.0.0-beta.15",
+ "@docusaurus/core": "2.0.0-beta.17",
+ "@docusaurus/plugin-content-blog": "2.0.0-beta.17",
+ "@docusaurus/plugin-content-docs": "2.0.0-beta.17",
+ "@docusaurus/plugin-content-pages": "2.0.0-beta.17",
+ "@docusaurus/theme-common": "2.0.0-beta.17",
+ "@docusaurus/theme-translations": "2.0.0-beta.17",
+ "@docusaurus/utils": "2.0.0-beta.17",
+ "@docusaurus/utils-common": "2.0.0-beta.17",
+ "@docusaurus/utils-validation": "2.0.0-beta.17",
"@mdx-js/react": "^1.6.22",
"clsx": "^1.1.1",
"copy-text-to-clipboard": "^3.0.1",
"infima": "0.2.0-alpha.37",
"lodash": "^4.17.21",
- "postcss": "^8.4.6",
+ "postcss": "^8.4.7",
"prism-react-renderer": "^1.2.1",
- "prismjs": "^1.26.0",
+ "prismjs": "^1.27.0",
"react-router-dom": "^5.2.0",
"rtlcss": "^3.3.0"
},
"devDependencies": {
- "@docusaurus/module-type-aliases": "2.0.0-beta.15",
- "@docusaurus/types": "2.0.0-beta.15",
+ "@docusaurus/module-type-aliases": "2.0.0-beta.17",
+ "@docusaurus/types": "2.0.0-beta.17",
"@types/mdx-js__react": "^1.5.5",
"@types/prismjs": "^1.26.0",
"@types/rtlcss": "^3.1.2",
"cross-env": "^7.0.3",
- "fs-extra": "^10.0.0",
+ "fs-extra": "^10.0.1",
"react-test-renderer": "^17.0.2",
"utility-types": "^3.10.0"
},
diff --git a/packages/docusaurus-theme-classic/src/__tests__/validateThemeConfig.test.ts b/packages/docusaurus-theme-classic/src/__tests__/validateThemeConfig.test.ts
index 67a2ec87a285..f9a97d31588d 100644
--- a/packages/docusaurus-theme-classic/src/__tests__/validateThemeConfig.test.ts
+++ b/packages/docusaurus-theme-classic/src/__tests__/validateThemeConfig.test.ts
@@ -5,7 +5,7 @@
* LICENSE file in the root directory of this source tree.
*/
-import {merge} from 'lodash';
+import _ from 'lodash';
import {ThemeConfigSchema, DEFAULT_CONFIG} from '../validateThemeConfig';
import {normalizeThemeConfig} from '@docusaurus/utils-validation';
@@ -507,18 +507,19 @@ describe('themeConfig', () => {
describe('color mode config', () => {
const withDefaultValues = (colorMode) =>
- merge({}, DEFAULT_CONFIG.colorMode, colorMode);
+ _.merge({}, DEFAULT_CONFIG.colorMode, colorMode);
- test('minimal config', () => {
+ test('switch config', () => {
const colorMode = {
switchConfig: {
darkIcon: '🌙',
},
};
- expect(testValidateThemeConfig({colorMode})).toEqual({
- ...DEFAULT_CONFIG,
- colorMode: withDefaultValues(colorMode),
- });
+ expect(() =>
+ testValidateThemeConfig({colorMode}),
+ ).toThrowErrorMatchingInlineSnapshot(
+ `"colorMode.switchConfig is deprecated. If you want to customize the icons for light and dark mode, swizzle IconLightMode, IconDarkMode, or ColorModeToggle instead."`,
+ );
});
test('max config', () => {
@@ -526,17 +527,6 @@ describe('themeConfig', () => {
defaultMode: 'dark',
disableSwitch: false,
respectPrefersColorScheme: true,
- switchConfig: {
- darkIcon: '🌙',
- darkIconStyle: {
- marginTop: '1px',
- marginLeft: '2px',
- },
- lightIcon: '☀️',
- lightIconStyle: {
- marginLeft: '1px',
- },
- },
};
expect(testValidateThemeConfig({colorMode})).toEqual({
...DEFAULT_CONFIG,
@@ -562,16 +552,6 @@ describe('themeConfig', () => {
},
});
});
-
- test('empty switch config', () => {
- const colorMode = {
- switchConfig: {},
- };
- expect(testValidateThemeConfig({colorMode})).toEqual({
- ...DEFAULT_CONFIG,
- colorMode: withDefaultValues(colorMode),
- });
- });
});
});
diff --git a/packages/docusaurus-theme-classic/src/getSwizzleConfig.ts b/packages/docusaurus-theme-classic/src/getSwizzleConfig.ts
new file mode 100644
index 000000000000..f185a7ba2e4f
--- /dev/null
+++ b/packages/docusaurus-theme-classic/src/getSwizzleConfig.ts
@@ -0,0 +1,123 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import type {SwizzleConfig} from '@docusaurus/types';
+
+/* eslint sort-keys: "error" */
+
+export default function getSwizzleConfig(): SwizzleConfig {
+ return {
+ components: {
+ CodeBlock: {
+ actions: {
+ eject: 'safe',
+ wrap: 'safe',
+ },
+ description:
+ 'The component used to render multi-line code blocks, generally used in Markdown files.',
+ },
+ ColorModeToggle: {
+ actions: {
+ eject: 'safe',
+ wrap: 'safe',
+ },
+ description:
+ 'The color mode toggle to switch between light and dark mode.',
+ },
+ DocSidebar: {
+ actions: {
+ eject: 'unsafe', // too much technical code in sidebar, not very safe atm
+ wrap: 'safe',
+ },
+ description: 'The sidebar component on docs pages',
+ },
+ Footer: {
+ actions: {
+ eject: 'unsafe', // TODO split footer into smaller parts
+ wrap: 'safe',
+ },
+ description: "The footer component of you site's layout",
+ },
+ IconArrow: {
+ actions: {
+ eject: 'safe',
+ wrap: 'safe',
+ },
+ description: 'The arrow icon component',
+ },
+ IconDarkMode: {
+ actions: {
+ eject: 'safe',
+ wrap: 'safe',
+ },
+ description: 'The dark mode icon component.',
+ },
+ IconEdit: {
+ actions: {
+ eject: 'safe',
+ wrap: 'safe',
+ },
+ description: 'The edit icon component',
+ },
+ IconLightMode: {
+ actions: {
+ eject: 'safe',
+ wrap: 'safe',
+ },
+ description: 'The light mode icon component.',
+ },
+ IconMenu: {
+ actions: {
+ eject: 'safe',
+ wrap: 'safe',
+ },
+ description: 'The menu icon component',
+ },
+ MDXComponents: {
+ actions: {
+ eject: 'safe',
+ wrap: 'forbidden', /// TODO allow wrapping objects???
+ },
+ description:
+ 'The MDX components to use for rendering MDX files. Meant to be ejected.',
+ },
+ // TODO should probably not even appear here
+ 'NavbarItem/utils': {
+ actions: {
+ eject: 'forbidden',
+ wrap: 'forbidden',
+ },
+ },
+ NotFound: {
+ actions: {
+ eject: 'safe',
+ wrap: 'safe',
+ },
+ description:
+ 'The global 404 page of your site, meant to be ejected and customized',
+ },
+ SearchBar: {
+ actions: {
+ eject: 'safe',
+ wrap: 'safe',
+ },
+ // TODO how to describe this one properly?
+ // By default it's an empty placeholder for the user to fill
+ description:
+ 'The search bar component of your site, appearing in the navbar.',
+ },
+ 'prism-include-languages': {
+ actions: {
+ eject: 'safe',
+ wrap: 'forbidden', // not a component!
+ },
+ description:
+ 'The Prism languages to include for code block syntax highlighting. Meant to be ejected.',
+ },
+ },
+ };
+}
diff --git a/packages/docusaurus-theme-classic/src/index.ts b/packages/docusaurus-theme-classic/src/index.ts
index 8434e3b0ff8d..c401e48ddb20 100644
--- a/packages/docusaurus-theme-classic/src/index.ts
+++ b/packages/docusaurus-theme-classic/src/index.ts
@@ -107,7 +107,7 @@ export default function docusaurusThemeClassic(
prism: {additionalLanguages = []} = {},
} = themeConfig;
const {customCss} = options || {};
- const {direction} = localeConfigs[currentLocale];
+ const {direction} = localeConfigs[currentLocale]!;
return {
name: 'docusaurus-theme-classic',
@@ -207,21 +207,5 @@ ${announcementBar ? AnnouncementBarInlineJavaScript : ''}
};
}
-const swizzleAllowedComponents = [
- 'CodeBlock',
- 'DocSidebar',
- 'Footer',
- 'NotFound',
- 'SearchBar',
- 'IconArrow',
- 'IconEdit',
- 'IconMenu',
- 'hooks/useTheme',
- 'prism-include-languages',
-];
-
-export function getSwizzleComponentList(): string[] {
- return swizzleAllowedComponents;
-}
-
+export {default as getSwizzleConfig} from './getSwizzleConfig';
export {validateThemeConfig} from './validateThemeConfig';
diff --git a/packages/docusaurus-theme-classic/src/theme-classic.d.ts b/packages/docusaurus-theme-classic/src/theme-classic.d.ts
index 3f2922aaadfb..d1f5be5333d5 100644
--- a/packages/docusaurus-theme-classic/src/theme-classic.d.ts
+++ b/packages/docusaurus-theme-classic/src/theme-classic.d.ts
@@ -24,8 +24,7 @@ declare module '@theme/Admonition' {
}
declare module '@theme/AnnouncementBar' {
- const AnnouncementBar: () => JSX.Element | null;
- export default AnnouncementBar;
+ export default function AnnouncementBar(): JSX.Element | null;
}
declare module '@theme/BackToTopButton' {
@@ -38,9 +37,7 @@ declare module '@theme/BlogListPaginator' {
export interface Props {
readonly metadata: Metadata;
}
-
- const BlogListPaginator: (props: Props) => JSX.Element;
- export default BlogListPaginator;
+ export default function BlogListPaginator(props: Props): JSX.Element;
}
declare module '@theme/BlogSidebar' {
@@ -54,8 +51,7 @@ declare module '@theme/BlogSidebar' {
readonly sidebar: BlogSidebar;
}
- const BlogSidebar: (props: Props) => JSX.Element;
- export default BlogSidebar;
+ export default function BlogSidebar(props: Props): JSX.Element;
}
declare module '@theme/BlogPostItem' {
@@ -71,8 +67,7 @@ declare module '@theme/BlogPostItem' {
readonly children: JSX.Element;
}
- const BlogPostItem: (props: Props) => JSX.Element;
- export default BlogPostItem;
+ export default function BlogPostItem(props: Props): JSX.Element;
}
declare module '@theme/BlogPostAuthor' {
@@ -105,8 +100,7 @@ declare module '@theme/BlogPostPaginator' {
readonly prevItem?: Item;
}
- const BlogPostPaginator: (props: Props) => JSX.Element;
- export default BlogPostPaginator;
+ export default function BlogPostPaginator(props: Props): JSX.Element;
}
declare module '@theme/BlogLayout' {
@@ -119,8 +113,7 @@ declare module '@theme/BlogLayout' {
readonly toc?: ReactNode;
}
- const BlogLayout: (props: Props) => JSX.Element;
- export default BlogLayout;
+ export default function BlogLayout(props: Props): JSX.Element;
}
declare module '@theme/CodeBlock' {
@@ -134,8 +127,7 @@ declare module '@theme/CodeBlock' {
readonly language?: string;
}
- const CodeBlock: (props: Props) => JSX.Element;
- export default CodeBlock;
+ export default function CodeBlock(props: Props): JSX.Element;
}
declare module '@theme/DocCard' {
@@ -185,8 +177,7 @@ declare module '@theme/DocSidebar' {
readonly [key: string]: unknown;
}
- const DocSidebar: (props: Props) => JSX.Element;
- export default DocSidebar;
+ export default function DocSidebar(props: Props): JSX.Element;
}
declare module '@theme/DocSidebarItem' {
@@ -208,9 +199,9 @@ declare module '@theme/DocSidebarItems' {
import type {Props as DocSidebarItemProps} from '@theme/DocSidebarItem';
import type {PropSidebarItem} from '@docusaurus/plugin-content-docs';
- export type Props = Omit & {
+ export interface Props extends Omit {
readonly items: readonly PropSidebarItem[];
- };
+ }
export default function DocSidebarItems(props: Props): JSX.Element;
}
@@ -232,16 +223,14 @@ declare module '@theme/DocVersionBadge' {
}
declare module '@theme/DocVersionSuggestions' {
- const DocVersionSuggestions: () => JSX.Element;
- export default DocVersionSuggestions;
+ export default function DocVersionSuggestions(): JSX.Element;
}
declare module '@theme/EditThisPage' {
export interface Props {
readonly editUrl: string;
}
- const EditThisPage: (props: Props) => JSX.Element;
- export default EditThisPage;
+ export default function EditThisPage(props: Props): JSX.Element;
}
declare module '@theme/ErrorPageContent' {
@@ -252,8 +241,7 @@ declare module '@theme/ErrorPageContent' {
}
declare module '@theme/Footer' {
- const Footer: () => JSX.Element | null;
- export default Footer;
+ export default function Footer(): JSX.Element | null;
}
declare module '@theme/Heading' {
@@ -315,8 +303,7 @@ declare module '@theme/SearchMetadata' {
readonly tag?: string;
}
- const SearchMetadata: (props: Props) => JSX.Element;
- export default SearchMetadata;
+ export default function SearchMetadata(props: Props): JSX.Element;
}
declare module '@theme/LastUpdated' {
@@ -326,13 +313,11 @@ declare module '@theme/LastUpdated' {
readonly lastUpdatedBy?: string;
}
- const LastUpdated: (props: Props) => JSX.Element;
- export default LastUpdated;
+ export default function LastUpdated(props: Props): JSX.Element;
}
declare module '@theme/SkipToContent' {
- const SkipToContent: () => JSX.Element;
- export default SkipToContent;
+ export default function SkipToContent(): JSX.Element;
}
declare module '@theme/MDXComponents' {
@@ -359,8 +344,7 @@ declare module '@theme/MDXComponents' {
}
declare module '@theme/Navbar' {
- const Navbar: () => JSX.Element;
- export default Navbar;
+ export default function Navbar(): JSX.Element;
}
declare module '@theme/NavbarItem/DefaultNavbarItem' {
@@ -381,15 +365,15 @@ declare module '@theme/NavbarItem/DefaultNavbarItem' {
declare module '@theme/NavbarItem/NavbarNavLink' {
import type {ReactNode} from 'react';
- import type {LinkProps} from '@docusaurus/Link';
+ import type {Props as LinkProps} from '@docusaurus/Link';
- export type Props = LinkProps & {
+ export interface Props extends LinkProps {
readonly activeBasePath?: string;
readonly activeBaseRegex?: string;
readonly exact?: boolean;
readonly label?: ReactNode;
readonly prependBaseUrlToHref?: string;
- };
+ }
export default function NavbarNavLink(props: Props): JSX.Element;
}
@@ -409,8 +393,7 @@ declare module '@theme/NavbarItem/DropdownNavbarItem' {
readonly mobile?: boolean;
}
- const DropdownNavbarItem: (props: Props) => JSX.Element;
- export default DropdownNavbarItem;
+ export default function DropdownNavbarItem(props: Props): JSX.Element;
}
declare module '@theme/NavbarItem/SearchNavbarItem' {
@@ -418,8 +401,7 @@ declare module '@theme/NavbarItem/SearchNavbarItem' {
readonly mobile?: boolean;
}
- const SearchNavbarItem: (props: Props) => JSX.Element;
- export default SearchNavbarItem;
+ export default function SearchNavbarItem(props: Props): JSX.Element;
}
declare module '@theme/NavbarItem/LocaleDropdownNavbarItem' {
@@ -431,8 +413,7 @@ declare module '@theme/NavbarItem/LocaleDropdownNavbarItem' {
readonly dropdownItemsAfter: LinkLikeNavbarItemProps[];
}
- const LocaleDropdownNavbarItem: (props: Props) => JSX.Element;
- export default LocaleDropdownNavbarItem;
+ export default function LocaleDropdownNavbarItem(props: Props): JSX.Element;
}
declare module '@theme/NavbarItem/DocsVersionDropdownNavbarItem' {
@@ -446,8 +427,9 @@ declare module '@theme/NavbarItem/DocsVersionDropdownNavbarItem' {
readonly dropdownItemsAfter: LinkLikeNavbarItemProps[];
}
- const DocsVersionDropdownNavbarItem: (props: Props) => JSX.Element;
- export default DocsVersionDropdownNavbarItem;
+ export default function DocsVersionDropdownNavbarItem(
+ props: Props,
+ ): JSX.Element;
}
declare module '@theme/NavbarItem/DocsVersionNavbarItem' {
@@ -457,8 +439,7 @@ declare module '@theme/NavbarItem/DocsVersionNavbarItem' {
readonly docsPluginId?: string;
}
- const DocsVersionNavbarItem: (props: Props) => JSX.Element;
- export default DocsVersionNavbarItem;
+ export default function DocsVersionNavbarItem(props: Props): JSX.Element;
}
declare module '@theme/NavbarItem/DocNavbarItem' {
@@ -469,8 +450,7 @@ declare module '@theme/NavbarItem/DocNavbarItem' {
readonly docsPluginId?: string;
}
- const DocsSidebarNavbarItem: (props: Props) => JSX.Element;
- export default DocsSidebarNavbarItem;
+ export default function DocsSidebarNavbarItem(props: Props): JSX.Element;
}
declare module '@theme/NavbarItem/DocSidebarNavbarItem' {
@@ -481,8 +461,7 @@ declare module '@theme/NavbarItem/DocSidebarNavbarItem' {
readonly docsPluginId?: string;
}
- const DocSidebarNavbarItem: (props: Props) => JSX.Element;
- export default DocSidebarNavbarItem;
+ export default function DocSidebarNavbarItem(props: Props): JSX.Element;
}
declare module '@theme/NavbarItem' {
@@ -518,8 +497,7 @@ declare module '@theme/NavbarItem' {
export type Types = Props['type'];
- const NavbarItem: (props: Props) => JSX.Element;
- export default NavbarItem;
+ export default function NavbarItem(props: Props): JSX.Element;
}
declare module '@theme/NavbarItem/utils' {
@@ -555,8 +533,7 @@ declare module '@theme/TabItem' {
readonly attributes?: Record;
}
- const TabItem: (props: Props) => JSX.Element;
- export default TabItem;
+ export default function TabItem(props: Props): JSX.Element;
}
declare module '@theme/Tabs' {
@@ -577,8 +554,7 @@ declare module '@theme/Tabs' {
readonly className?: string;
}
- const Tabs: (props: Props) => JSX.Element;
- export default Tabs;
+ export default function Tabs(props: Props): JSX.Element;
}
declare module '@theme/ThemedImage' {
@@ -591,8 +567,7 @@ declare module '@theme/ThemedImage' {
};
}
- const ThemedImage: (props: Props) => JSX.Element;
- export default ThemedImage;
+ export default function ThemedImage(props: Props): JSX.Element;
}
declare module '@theme/Details' {
@@ -605,71 +580,59 @@ declare module '@theme/Details' {
declare module '@theme/TOCItems' {
import type {TOCItem} from '@docusaurus/types';
- export type TOCItemsProps = {
+ export interface Props {
readonly toc: readonly TOCItem[];
readonly minHeadingLevel?: number;
readonly maxHeadingLevel?: number;
readonly className?: string;
readonly linkClassName?: string | null;
readonly linkActiveClassName?: string;
- };
+ }
- export default function TOCItems(props: TOCItemsProps): JSX.Element;
+ export default function TOCItems(props: Props): JSX.Element;
}
declare module '@theme/TOC' {
import type {TOCItem} from '@docusaurus/types';
- // minHeadingLevel only exists as a per-doc option,
- // and won't have a default set by Joi. See TOC, TOCInline,
- // TOCCollapsible for examples
- export type TOCProps = {
+ // minHeadingLevel only exists as a per-doc option, and won't have a default
+ // set by Joi. See TOC, TOCInline, TOCCollapsible for examples
+ export interface Props {
readonly toc: readonly TOCItem[];
readonly minHeadingLevel?: number;
readonly maxHeadingLevel?: number;
readonly className?: string;
- };
-
- export type TOCHeadingsProps = {
- readonly toc: readonly TOCItem[];
- readonly minHeadingLevel?: number;
- readonly maxHeadingLevel?: number;
- };
-
- export const TOCHeadings: (props: TOCHeadingsProps) => JSX.Element;
+ }
- const TOC: (props: TOCProps) => JSX.Element;
- export default TOC;
+ export default function TOC(props: Props): JSX.Element;
}
declare module '@theme/TOCInline' {
import type {TOCItem} from '@docusaurus/types';
- export type TOCInlineProps = {
+ export interface Props {
readonly toc: readonly TOCItem[];
readonly minHeadingLevel?: number;
readonly maxHeadingLevel?: number;
- };
+ }
- const TOCInline: (props: TOCInlineProps) => JSX.Element;
- export default TOCInline;
+ export default function TOCInline(props: Props): JSX.Element;
}
declare module '@theme/TOCCollapsible' {
import type {TOCItem} from '@docusaurus/types';
- export type TOCCollapsibleProps = {
+ export interface Props {
readonly className?: string;
readonly minHeadingLevel?: number;
readonly maxHeadingLevel?: number;
readonly toc: readonly TOCItem[];
- };
+ }
- const TOCCollapsible: (props: TOCCollapsibleProps) => JSX.Element;
- export default TOCCollapsible;
+ export default function TOCCollapsible(props: Props): JSX.Element;
}
-declare module '@theme/Toggle' {
+declare module '@theme/ColorModeToggle' {
import type {SyntheticEvent} from 'react';
export interface Props {
@@ -678,8 +641,7 @@ declare module '@theme/Toggle' {
readonly onChange: (e: SyntheticEvent) => void;
}
- const Toggle: (props: Props) => JSX.Element;
- export default Toggle;
+ export default function Toggle(props: Props): JSX.Element;
}
declare module '@theme/Logo' {
@@ -690,8 +652,7 @@ declare module '@theme/Logo' {
readonly titleClassName?: string;
}
- const Logo: (props: Props) => JSX.Element;
- export default Logo;
+ export default function Logo(props: Props): JSX.Element;
}
declare module '@theme/IconArrow' {
@@ -699,8 +660,15 @@ declare module '@theme/IconArrow' {
export interface Props extends ComponentProps<'svg'> {}
- const IconArrow: (props: Props) => JSX.Element;
- export default IconArrow;
+ export default function IconArrow(props: Props): JSX.Element;
+}
+
+declare module '@theme/IconDarkMode' {
+ import type {ComponentProps} from 'react';
+
+ export interface Props extends ComponentProps<'svg'> {}
+
+ export default function IconDarkMode(props: Props): JSX.Element;
}
declare module '@theme/IconEdit' {
@@ -708,8 +676,15 @@ declare module '@theme/IconEdit' {
export interface Props extends ComponentProps<'svg'> {}
- const IconEdit: (props: Props) => JSX.Element;
- export default IconEdit;
+ export default function IconEdit(props: Props): JSX.Element;
+}
+
+declare module '@theme/IconLightMode' {
+ import type {ComponentProps} from 'react';
+
+ export interface Props extends ComponentProps<'svg'> {}
+
+ export default function IconLightMode(props: Props): JSX.Element;
}
declare module '@theme/IconMenu' {
@@ -717,8 +692,7 @@ declare module '@theme/IconMenu' {
export interface Props extends ComponentProps<'svg'> {}
- const IconMenu: (props: Props) => JSX.Element;
- export default IconMenu;
+ export default function IconMenu(props: Props): JSX.Element;
}
declare module '@theme/IconClose' {
@@ -726,8 +700,7 @@ declare module '@theme/IconClose' {
export interface Props extends ComponentProps<'svg'> {}
- const IconClose: (props: Props) => JSX.Element;
- export default IconClose;
+ export default function IconClose(props: Props): JSX.Element;
}
declare module '@theme/IconLanguage' {
@@ -735,8 +708,7 @@ declare module '@theme/IconLanguage' {
export interface Props extends ComponentProps<'svg'> {}
- const IconLanguage: (props: Props) => JSX.Element;
- export default IconLanguage;
+ export default function IconLanguage(props: Props): JSX.Element;
}
declare module '@theme/IconExternalLink' {
@@ -744,8 +716,7 @@ declare module '@theme/IconExternalLink' {
export interface Props extends ComponentProps<'svg'> {}
- const IconExternalLink: (props: Props) => JSX.Element;
- export default IconExternalLink;
+ export default function IconExternalLink(props: Props): JSX.Element;
}
declare module '@theme/TagsListByLetter' {
@@ -796,6 +767,5 @@ declare module '@theme/Seo' {
readonly children?: ReactNode;
}
- const Seo: (props: Props) => JSX.Element;
- export default Seo;
+ export default function Seo(props: Props): JSX.Element;
}
diff --git a/packages/docusaurus-theme-classic/src/theme/AnnouncementBar/index.tsx b/packages/docusaurus-theme-classic/src/theme/AnnouncementBar/index.tsx
index f42acb6a197d..26ad85727639 100644
--- a/packages/docusaurus-theme-classic/src/theme/AnnouncementBar/index.tsx
+++ b/packages/docusaurus-theme-classic/src/theme/AnnouncementBar/index.tsx
@@ -13,7 +13,7 @@ import IconClose from '@theme/IconClose';
import styles from './styles.module.css';
-function AnnouncementBar(): JSX.Element | null {
+export default function AnnouncementBar(): JSX.Element | null {
const {isActive, close} = useAnnouncementBar();
const {announcementBar} = useThemeConfig();
@@ -51,5 +51,3 @@ function AnnouncementBar(): JSX.Element | null {
);
}
-
-export default AnnouncementBar;
diff --git a/packages/docusaurus-theme-classic/src/theme/BackToTopButton/index.tsx b/packages/docusaurus-theme-classic/src/theme/BackToTopButton/index.tsx
index 2a36a576b5ef..1a3bb4a545f2 100644
--- a/packages/docusaurus-theme-classic/src/theme/BackToTopButton/index.tsx
+++ b/packages/docusaurus-theme-classic/src/theme/BackToTopButton/index.tsx
@@ -73,7 +73,7 @@ function useSmoothScrollToTop(): UseSmoothScrollTopReturn {
};
}
-function BackToTopButton(): JSX.Element {
+export default function BackToTopButton(): JSX.Element {
const [show, setShow] = useState(false);
const isFocusedAnchor = useRef(false);
const {smoothScrollTop, cancelScrollToTop} = useSmoothScrollToTop();
@@ -133,7 +133,7 @@ function BackToTopButton(): JSX.Element {
ThemeClassNames.common.backToTopButton,
styles.backToTopButton,
{
- [styles.backToTopButtonShow]: show,
+ [styles.backToTopButtonShow!]: show,
},
)}
type="button"
@@ -141,5 +141,3 @@ function BackToTopButton(): JSX.Element {
/>
);
}
-
-export default BackToTopButton;
diff --git a/packages/docusaurus-theme-classic/src/theme/BlogLayout/index.tsx b/packages/docusaurus-theme-classic/src/theme/BlogLayout/index.tsx
index 623b112c629f..08c183746090 100644
--- a/packages/docusaurus-theme-classic/src/theme/BlogLayout/index.tsx
+++ b/packages/docusaurus-theme-classic/src/theme/BlogLayout/index.tsx
@@ -12,7 +12,7 @@ import BlogSidebar from '@theme/BlogSidebar';
import type {Props} from '@theme/BlogLayout';
-function BlogLayout(props: Props): JSX.Element {
+export default function BlogLayout(props: Props): JSX.Element {
const {sidebar, toc, children, ...layoutProps} = props;
const hasSidebar = sidebar && sidebar.items.length > 0;
@@ -40,5 +40,3 @@ function BlogLayout(props: Props): JSX.Element {
);
}
-
-export default BlogLayout;
diff --git a/packages/docusaurus-theme-classic/src/theme/BlogListPage/index.tsx b/packages/docusaurus-theme-classic/src/theme/BlogListPage/index.tsx
index 93202f38766c..088d6e67f169 100644
--- a/packages/docusaurus-theme-classic/src/theme/BlogListPage/index.tsx
+++ b/packages/docusaurus-theme-classic/src/theme/BlogListPage/index.tsx
@@ -14,7 +14,7 @@ import BlogListPaginator from '@theme/BlogListPaginator';
import type {Props} from '@theme/BlogListPage';
import {ThemeClassNames} from '@docusaurus/theme-common';
-function BlogListPage(props: Props): JSX.Element {
+export default function BlogListPage(props: Props): JSX.Element {
const {metadata, items, sidebar} = props;
const {
siteConfig: {title: siteTitle},
@@ -48,5 +48,3 @@ function BlogListPage(props: Props): JSX.Element {
);
}
-
-export default BlogListPage;
diff --git a/packages/docusaurus-theme-classic/src/theme/BlogListPaginator/index.tsx b/packages/docusaurus-theme-classic/src/theme/BlogListPaginator/index.tsx
index 9eb127d2cbec..415f4f86369c 100644
--- a/packages/docusaurus-theme-classic/src/theme/BlogListPaginator/index.tsx
+++ b/packages/docusaurus-theme-classic/src/theme/BlogListPaginator/index.tsx
@@ -10,7 +10,7 @@ import Translate, {translate} from '@docusaurus/Translate';
import PaginatorNavLink from '@theme/PaginatorNavLink';
import type {Props} from '@theme/BlogListPaginator';
-function BlogListPaginator(props: Props): JSX.Element {
+export default function BlogListPaginator(props: Props): JSX.Element {
const {metadata} = props;
const {previousPage, nextPage} = metadata;
@@ -53,5 +53,3 @@ function BlogListPaginator(props: Props): JSX.Element {
);
}
-
-export default BlogListPaginator;
diff --git a/packages/docusaurus-theme-classic/src/theme/BlogPostAuthor/index.tsx b/packages/docusaurus-theme-classic/src/theme/BlogPostAuthor/index.tsx
index aebe83109c05..f4d32b74ca80 100644
--- a/packages/docusaurus-theme-classic/src/theme/BlogPostAuthor/index.tsx
+++ b/packages/docusaurus-theme-classic/src/theme/BlogPostAuthor/index.tsx
@@ -6,19 +6,29 @@
*/
import React from 'react';
-import Link from '@docusaurus/Link';
+import Link, {type Props as LinkProps} from '@docusaurus/Link';
import type {Props} from '@theme/BlogPostAuthor';
import styles from './styles.module.css';
-function BlogPostAuthor({author}: Props): JSX.Element {
- const {name, title, url, imageURL} = author;
+function MaybeLink(props: LinkProps): JSX.Element {
+ if (props.href) {
+ return
;
+ }
+ return <>{props.children};
+}
+
+export default function BlogPostAuthor({author}: Props): JSX.Element {
+ const {name, title, url, imageURL, email} = author;
+ const link = url || (email && `mailto:${email}`) || undefined;
return (
);
}
-
-export default BlogPostAuthor;
diff --git a/packages/docusaurus-theme-classic/src/theme/BlogPostItem/index.tsx b/packages/docusaurus-theme-classic/src/theme/BlogPostItem/index.tsx
index 2524725b0a60..974cf93ad01a 100644
--- a/packages/docusaurus-theme-classic/src/theme/BlogPostItem/index.tsx
+++ b/packages/docusaurus-theme-classic/src/theme/BlogPostItem/index.tsx
@@ -41,7 +41,7 @@ function useReadingTimePlural() {
};
}
-function BlogPostItem(props: Props): JSX.Element {
+export default function BlogPostItem(props: Props): JSX.Element {
const readingTimePlural = useReadingTimePlural();
const {withBaseUrl} = useBaseUrlUtils();
const {
@@ -114,7 +114,7 @@ function BlogPostItem(props: Props): JSX.Element {
{(tagsExists || truncated) && (
> **We are working hard on Docusaurus v2. If you are new to Docusaurus, try using the new version instead of v1. See the [Docusaurus v2 website](https://docusaurus.io/) for more details.**
diff --git a/admin/new.docusaurus.io/package.json b/admin/new.docusaurus.io/package.json
index 7a12cd8325c3..42f07b9d5a0a 100644
--- a/admin/new.docusaurus.io/package.json
+++ b/admin/new.docusaurus.io/package.json
@@ -1,14 +1,14 @@
{
"name": "new.docusaurus.io",
- "version": "2.0.0-beta.15",
+ "version": "2.0.0-beta.17",
"private": true,
"scripts": {
"start": "netlify dev"
},
"dependencies": {
- "@netlify/functions": "^0.11.0"
+ "@netlify/functions": "^1.0.0"
},
"devDependencies": {
- "netlify-cli": "^9.4.0"
+ "netlify-cli": "^9.8.4"
}
}
diff --git a/admin/publish.md b/admin/publish.md
index 699ab5106a70..fef93b58796c 100644
--- a/admin/publish.md
+++ b/admin/publish.md
@@ -118,7 +118,7 @@ You should still be on your local branch `