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

feat: make tags route path configurable (#5545)

Browse source
This commit is contained in:
Alexey Pyltsyn 2021-09-21 20:19:18 +03:00 • committed by GitHub
parent ba402e9e63
commit 29e06d0677
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 28 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

1
packages/docusaurus-plugin-content-docs/src/__tests__/options.test.ts
View file

@ -40,6 +40,7 @@ describe('normalizeDocsPluginOptions', () => {
const userOptions = {
path: 'my-docs', // Path to data on filesystem, relative to site dir.
routeBasePath: 'my-docs', // URL Route.
tagsBasePath: 'tags', // URL Tags Route.
homePageId: 'home', // Document id for docs home page.
include: ['**/*.{md,mdx}'], // Extensions to include.
exclude: GlobExcludeDefault,

2
packages/docusaurus-plugin-content-docs/src/options.ts
View file

@ -26,6 +26,7 @@ import {
export const DEFAULT_OPTIONS: Omit<PluginOptions, 'id' | 'sidebarPath'> = {
path: 'docs', // Path to data on filesystem, relative to site dir.
routeBasePath: 'docs', // URL Route.
tagsBasePath: 'tags', // URL Tags Route.
homePageId: undefined, // TODO remove soon, deprecated
include: ['**/*.{md,mdx}'], // Extensions to include.
exclude: GlobExcludeDefault,
@ -73,6 +74,7 @@ export const OptionsSchema = Joi.object({
// '' not allowed, see https://github.com/facebook/docusaurus/issues/3374
// .allow('') ""
.default(DEFAULT_OPTIONS.routeBasePath),
tagsBasePath: Joi.string().default(DEFAULT_OPTIONS.tagsBasePath),
homePageId: Joi.string().optional(),
include: Joi.array().items(Joi.string()).default(DEFAULT_OPTIONS.include),
exclude: Joi.array().items(Joi.string()).default(DEFAULT_OPTIONS.exclude),

1
packages/docusaurus-plugin-content-docs/src/types.ts
View file

@ -101,6 +101,7 @@ export type PluginOptions = MetadataOptions &
disableVersioning: boolean;
includeCurrentVersion: boolean;
sidebarItemsGenerator: SidebarItemsGeneratorOption;
tagsBasePath: string;
};
export type SidebarItemBase = {

4
packages/docusaurus-plugin-content-docs/src/versions.ts
View file

@ -349,6 +349,7 @@ function createVersionMetadata({
| 'path'
| 'sidebarPath'
| 'routeBasePath'
| 'tagsBasePath'
| 'versions'
| 'editUrl'
| 'editCurrentVersion'
@ -400,7 +401,7 @@ function createVersionMetadata({
// the path that will be used to refer the docs tags
// example below will be using /docs/tags
const tagsPath = normalizeUrl([versionPath, 'tags']);
const tagsPath = normalizeUrl([versionPath, options.tagsBasePath]);
return {
versionName,
@ -561,6 +562,7 @@ export function readVersionsMetadata({
| 'path'
| 'sidebarPath'
| 'routeBasePath'
| 'tagsBasePath'
| 'includeCurrentVersion'
| 'disableVersioning'
| 'lastVersion'