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

feat(v2): docs, make numberPrefixParser configurable, better defaults, minor breaking-changes (#4655)

Browse source 
* make number prefix parsing logic configurable

* Make numberPrefixParser configurable + rename frontmatter + avoid parsing date/version patterns by default

* add more tests

* more test cases
This commit is contained in:
Sébastien Lorber 2021-04-21 12:06:06 +02:00 • committed by GitHub
parent d0d29f43cc
commit c04e613ffe
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
14 changed files with 325 additions and 82 deletions
Download patch file Download diff file Expand all files Collapse all files

7
packages/docusaurus-plugin-content-docs/src/sidebars.ts
View file

@ -24,6 +24,7 @@ import {
SidebarItemsGenerator,
SidebarItemsGeneratorDoc,
SidebarItemsGeneratorVersion,
NumberPrefixParser,
} from './types';
import {mapValues, flatten, flatMap, difference, pick, memoize} from 'lodash';
import {getElementsAround} from '@docusaurus/utils';
@ -289,11 +290,13 @@ export function toSidebarItemsGeneratorVersion(
// Handle the generation of autogenerated sidebar items
export async function processSidebar({
sidebarItemsGenerator,
numberPrefixParser,
unprocessedSidebar,
docs,
version,
}: {
sidebarItemsGenerator: SidebarItemsGenerator;
numberPrefixParser: NumberPrefixParser;
unprocessedSidebar: UnprocessedSidebar;
docs: DocMetadataBase[];
version: VersionMetadata;
@ -318,6 +321,7 @@ export async function processSidebar({
if (item.type === 'autogenerated') {
return sidebarItemsGenerator({
item,
numberPrefixParser,
...getSidebarItemsGeneratorDocsAndVersion(),
});
}
@ -329,11 +333,13 @@ export async function processSidebar({
export async function processSidebars({
sidebarItemsGenerator,
numberPrefixParser,
unprocessedSidebars,
docs,
version,
}: {
sidebarItemsGenerator: SidebarItemsGenerator;
numberPrefixParser: NumberPrefixParser;
unprocessedSidebars: UnprocessedSidebars;
docs: DocMetadataBase[];
version: VersionMetadata;
@ -342,6 +348,7 @@ export async function processSidebars({
mapValues(unprocessedSidebars, (unprocessedSidebar) =>
processSidebar({
sidebarItemsGenerator,
numberPrefixParser,
unprocessedSidebar,
docs,
version,