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

feat(v2): introduce docs slug in front matter (#2771)

Browse source 
* feat: docs pathname frontmatter (for #2697)

* feat: docs pathname frontmatter (for #2697)

* chore: comment typo

* feat: add slug frontmatter for docs

* test: add tests for versioned sites slugs

* docs: document slug feature

* test: fix tests and snapshots about doc slug feature

* docs(v2): doc slug wording

* Update website/docs/docs.md

Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>

Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
This commit is contained in:
Sébastien Lorber 2020-06-02 19:50:30 +02:00 • committed by GitHub
parent a32422caa2
commit b8de9c6ded
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
10 changed files with 71 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

14
packages/docusaurus-plugin-content-docs/src/metadata.ts
View file

@ -98,13 +98,18 @@ export default async function processMetadata({
// Default base id is the file name.
const baseID: string =
frontMatter.id || path.basename(source, path.extname(source));
if (baseID.includes('/')) {
throw new Error('Document id cannot include "/".');
}
// Append subdirectory as part of id.
const baseSlug: string = frontMatter.slug || baseID;
if (baseSlug.includes('/')) {
throw new Error('Document slug cannot include "/".');
}
// Append subdirectory as part of id/slug.
const id = dirName !== '.' ? `${dirName}/${baseID}` : baseID;
const slug = dirName !== '.' ? `${dirName}/${baseSlug}` : baseSlug;
// Default title is the id.
const title: string = frontMatter.title || baseID;
@ -114,8 +119,9 @@ export default async function processMetadata({
// The last portion of the url path. Eg: 'foo/bar', 'bar'.
const routePath =
version && version !== 'next'
? id.replace(new RegExp(`^version-${version}/`), '')
: id;
? slug.replace(new RegExp(`^version-${version}/`), '')
: slug;
const permalink = normalizeUrl([
baseUrl,
routeBasePath,