mirror of
https://github.com/facebook/docusaurus.git
synced 2025-07-20 18:17:51 +02:00
8bdb3da233
* create a swizzleWarning partial for shared text * Generalize usage of _ prefix convention to exclude content files/folders * add api doc * MDX loader should not expect metadata/frontmatter on MDX partial files
44 lines
1.6 KiB
TypeScript
44 lines
1.6 KiB
TypeScript
/**
|
|
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*/
|
|
import {PluginOptions} from './types';
|
|
import {
|
|
Joi,
|
|
RemarkPluginsSchema,
|
|
RehypePluginsSchema,
|
|
AdmonitionsSchema,
|
|
} from '@docusaurus/utils-validation';
|
|
import {GlobExcludeDefault} from '@docusaurus/utils';
|
|
|
|
export const DEFAULT_OPTIONS: PluginOptions = {
|
|
path: 'src/pages', // Path to data on filesystem, relative to site dir.
|
|
routeBasePath: '/', // URL Route.
|
|
include: ['**/*.{js,jsx,ts,tsx,md,mdx}'], // Extensions to include.
|
|
exclude: GlobExcludeDefault,
|
|
mdxPageComponent: '@theme/MDXPage',
|
|
remarkPlugins: [],
|
|
rehypePlugins: [],
|
|
beforeDefaultRehypePlugins: [],
|
|
beforeDefaultRemarkPlugins: [],
|
|
admonitions: {},
|
|
};
|
|
|
|
export const PluginOptionSchema = Joi.object({
|
|
path: Joi.string().default(DEFAULT_OPTIONS.path),
|
|
routeBasePath: Joi.string().default(DEFAULT_OPTIONS.routeBasePath),
|
|
include: Joi.array().items(Joi.string()).default(DEFAULT_OPTIONS.include),
|
|
exclude: Joi.array().items(Joi.string()).default(DEFAULT_OPTIONS.exclude),
|
|
mdxPageComponent: Joi.string().default(DEFAULT_OPTIONS.mdxPageComponent),
|
|
remarkPlugins: RemarkPluginsSchema.default(DEFAULT_OPTIONS.remarkPlugins),
|
|
rehypePlugins: RehypePluginsSchema.default(DEFAULT_OPTIONS.rehypePlugins),
|
|
beforeDefaultRehypePlugins: RehypePluginsSchema.default(
|
|
DEFAULT_OPTIONS.beforeDefaultRehypePlugins,
|
|
),
|
|
beforeDefaultRemarkPlugins: RemarkPluginsSchema.default(
|
|
DEFAULT_OPTIONS.beforeDefaultRemarkPlugins,
|
|
),
|
|
admonitions: AdmonitionsSchema.default(DEFAULT_OPTIONS.admonitions),
|
|
});
|