3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-17 11:07:07 +02:00
Code Issues Projects Releases Packages Wiki Activity

feat(v2): blog slug frontmatter (#3284)

Browse source
This commit is contained in:
Jean-Marc Saad 2020-08-20 15:59:54 +03:00 • committed by GitHub
parent 0f357606cd
commit 3ea2f8cfde
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
16 changed files with 107 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

7
packages/docusaurus-plugin-content-blog/src/__tests__/__fixtures__/website/blog/complex-slug.md Normal file
View file

@ -0,0 +1,7 @@
---
slug: /hey/my super path/héllô
title: Complex Slug
date: 2020-08-16
---
complex url slug

7
packages/docusaurus-plugin-content-blog/src/__tests__/__fixtures__/website/blog/simple-slug.md Normal file
View file

@ -0,0 +1,7 @@
---
slug: /simple/slug
title: Simple Slug
date: 2020-08-16
---
simple url slug

8
packages/docusaurus-plugin-content-blog/src/__tests__/__snapshots__/generateBlogFeed.test.ts.snap
View file

@ -28,14 +28,14 @@ exports[`blogFeed atom shows feed item for each post 1`] = `
<entry>
<title type=\\"html\\"><![CDATA[draft]]></title>
<id>draft</id>
<link href=\\"https://docusaurus.io/blog/2020/02/27/draft\\"/>
<link href=\\"https://docusaurus.io/blog/draft\\"/>
<updated>2020-02-27T00:00:00.000Z</updated>
<summary type=\\"html\\"><![CDATA[this post should not be published yet]]></summary>
</entry>
<entry>
<title type=\\"html\\"><![CDATA[date-matter]]></title>
<id>date-matter</id>
<link href=\\"https://docusaurus.io/blog/2019/01/01/date-matter\\"/>
<link href=\\"https://docusaurus.io/blog/date-matter\\"/>
<updated>2019-01-01T00:00:00.000Z</updated>
<summary type=\\"html\\"><![CDATA[date inside front matter]]></summary>
</entry>
@ -77,14 +77,14 @@ exports[`blogFeed rss shows feed item for each post 1`] = `
<copyright>Copyright</copyright>
<item>
<title><![CDATA[draft]]></title>
<link>https://docusaurus.io/blog/2020/02/27/draft</link>
<link>https://docusaurus.io/blog/draft</link>
<guid>draft</guid>
<pubDate>Thu, 27 Feb 2020 00:00:00 GMT</pubDate>
<description><![CDATA[this post should not be published yet]]></description>
</item>
<item>
<title><![CDATA[date-matter]]></title>
<link>https://docusaurus.io/blog/2019/01/01/date-matter</link>
<link>https://docusaurus.io/blog/date-matter</link>
<guid>date-matter</guid>
<pubDate>Tue, 01 Jan 2019 00:00:00 GMT</pubDate>
<description><![CDATA[date inside front matter]]></description>

54
packages/docusaurus-plugin-content-blog/src/__tests__/index.test.ts
View file

@ -53,10 +53,6 @@ describe('loadBlog', () => {
const noDateSourceBirthTime = (
await fs.stat(noDateSource.replace('@site', siteDir))
).birthtime;
const noDatePermalink = `/blog/${noDateSourceBirthTime
.toISOString()
.substr(0, '2019-01-01'.length)
.replace(/-/g, '/')}/no date`;
expect({
...blogPosts.find((v) => v.metadata.title === 'date-matter').metadata,
@ -64,7 +60,7 @@ describe('loadBlog', () => {
}).toEqual({
editUrl:
'https://github.com/facebook/docusaurus/edit/master/website-1x/blog/date-matter.md',
permalink: '/blog/2019/01/01/date-matter',
permalink: '/blog/date-matter',
readingTime: 0.02,
source: path.join('@site', pluginPath, 'date-matter.md'),
title: 'date-matter',
@ -97,7 +93,7 @@ describe('loadBlog', () => {
date: new Date('2018-12-14'),
tags: [],
prevItem: {
permalink: '/blog/2019/01/01/date-matter',
permalink: '/blog/date-matter',
title: 'date-matter',
},
truncated: false,
@ -109,7 +105,7 @@ describe('loadBlog', () => {
}).toEqual({
editUrl:
'https://github.com/facebook/docusaurus/edit/master/website-1x/blog/no date.md',
permalink: noDatePermalink,
permalink: '/blog/no date',
readingTime: 0.01,
source: noDateSource,
title: 'no date',
@ -118,9 +114,51 @@ describe('loadBlog', () => {
tags: [],
prevItem: undefined,
nextItem: {
permalink: '/blog/2020/02/27/draft',
permalink: '/blog/hey/my super path/héllô',
title: 'Complex Slug',
},
truncated: false,
});
expect({
...blogPosts.find((v) => v.metadata.title === 'Complex Slug').metadata,
...{prevItem: undefined},
}).toEqual({
editUrl:
'https://github.com/facebook/docusaurus/edit/master/website-1x/blog/complex-slug.md',
permalink: '/blog/hey/my super path/héllô',
readingTime: 0.015,
source: path.join('@site', pluginPath, 'complex-slug.md'),
title: 'Complex Slug',
description: `complex url slug`,
prevItem: undefined,
nextItem: {
permalink: '/blog/simple/slug',
title: 'Simple Slug',
},
date: new Date('2020-08-16'),
tags: [],
truncated: false,
});
expect({
...blogPosts.find((v) => v.metadata.title === 'Simple Slug').metadata,
...{prevItem: undefined},
}).toEqual({
editUrl:
'https://github.com/facebook/docusaurus/edit/master/website-1x/blog/simple-slug.md',
permalink: '/blog/simple/slug',
readingTime: 0.015,
source: path.join('@site', pluginPath, 'simple-slug.md'),
title: 'Simple Slug',
description: `simple url slug`,
prevItem: undefined,
nextItem: {
permalink: '/blog/draft',
title: 'draft',
},
date: new Date('2020-08-16'),
tags: [],
truncated: false,
});
});

20
packages/docusaurus-plugin-content-blog/src/blogUtils.ts
View file

@ -7,6 +7,7 @@
import fs from 'fs-extra';
import globby from 'globby';
import chalk from 'chalk';
import path from 'path';
import readingTime from 'reading-time';
import {Feed} from 'feed';
@ -126,6 +127,14 @@ export async function generateBlogPosts(
return;
}
if (frontMatter.id) {
console.warn(
chalk.yellow(
`${blogFileName} - 'id' header option is deprecated. Please use 'slug' option instead.`,
),
);
}
let date;
// Extract date and title from filename.
const match = blogFileName.match(FILENAME_PATTERN);
@ -144,16 +153,15 @@ export async function generateBlogPosts(
// Use file create time for blog.
date = date || (await fs.stat(source)).birthtime;
const slug =
frontMatter.slug || (match ? toUrl({date, link: linkName}) : linkName);
frontMatter.title = frontMatter.title || linkName;
blogPosts.push({
id: frontMatter.id || frontMatter.title,
id: frontMatter.slug || frontMatter.title,
metadata: {
permalink: normalizeUrl([
baseUrl,
routeBasePath,
frontMatter.id || toUrl({date, link: linkName}),
]),
permalink: normalizeUrl([baseUrl, routeBasePath, slug]),
editUrl: editBlogUrl,
source: aliasedSource,
description: frontMatter.description || excerpt,