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

feat(content-docs): sidebar category linking to document or auto-generated index page (#5830)

Browse source 
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Co-authored-by: Armano <armano2@users.noreply.github.com>
Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
This commit is contained in:
Sébastien Lorber 2021-12-03 14:44:59 +01:00 • committed by GitHub
parent 95f911efef
commit cfae5d0933
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
105 changed files with 3904 additions and 816 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -8,11 +8,12 @@
import fs from 'fs-extra';
import importFresh from 'import-fresh';
import type {SidebarsConfig, Sidebars, NormalizedSidebars} from './types';
import type {PluginOptions} from '../types';
import type {NormalizeSidebarsParams, PluginOptions} from '../types';
import {validateSidebars} from './validation';
import {normalizeSidebars} from './normalization';
import {processSidebars, SidebarProcessorProps} from './processor';
import {processSidebars, SidebarProcessorParams} from './processor';
import path from 'path';
import {createSlugger} from '@docusaurus/utils';
export const DefaultSidebars: SidebarsConfig = {
defaultSidebar: [
@ -36,7 +37,7 @@ export function resolveSidebarPathOption(
: sidebarPathOption;
}
function loadSidebarFile(
function loadSidebarsFileUnsafe(
sidebarFilePath: string | false | undefined,
): SidebarsConfig {
// false => no sidebars
@ -60,25 +61,34 @@ function loadSidebarFile(
return importFresh(sidebarFilePath);
}
export function loadUnprocessedSidebars(
export function loadSidebarsFile(
sidebarFilePath: string | false | undefined,
options: SidebarProcessorProps['options'],
): NormalizedSidebars {
const sidebarsConfig = loadSidebarFile(sidebarFilePath);
): SidebarsConfig {
const sidebarsConfig = loadSidebarsFileUnsafe(sidebarFilePath);
validateSidebars(sidebarsConfig);
return sidebarsConfig;
}
const normalizedSidebars = normalizeSidebars(sidebarsConfig, options);
return normalizedSidebars;
export function loadNormalizedSidebars(
sidebarFilePath: string | false | undefined,
params: NormalizeSidebarsParams,
): NormalizedSidebars {
return normalizeSidebars(loadSidebarsFile(sidebarFilePath), params);
}
// Note: sidebarFilePath must be absolute, use resolveSidebarPathOption
export async function loadSidebars(
sidebarFilePath: string | false | undefined,
options: SidebarProcessorProps,
options: SidebarProcessorParams,
): Promise<Sidebars> {
const unprocessedSidebars = loadUnprocessedSidebars(
const normalizeSidebarsParams: NormalizeSidebarsParams = {
...options.sidebarOptions,
version: options.version,
categoryLabelSlugger: createSlugger(),
};
const normalizedSidebars = loadNormalizedSidebars(
sidebarFilePath,
options.options,
normalizeSidebarsParams,
);
return processSidebars(unprocessedSidebars, options);
return processSidebars(normalizedSidebars, options);
}