📦 plugin-content-docs

Provides the Docs functionality and is the default docs plugin for Docusaurus.

安装流程

npm

npm install --save @docusaurus/plugin-content-docs

Yarn

yarn add @docusaurus/plugin-content-docs

pnpm

pnpm add @docusaurus/plugin-content-docs

Bun

bun add @docusaurus/plugin-content-docs

提示

If you use the preset @docusaurus/preset-classic, you don't need to install this plugin as a dependency.

You can configure this plugin through the preset options.

配置

接受的字段：

参数	类型	默认值	描述
path	string	'docs'	文档内容目录的文件系统路径，相对于站点目录。
editUrl	string | EditUrlFunction	undefined	编辑文档的基础 URL。 The final URL is computed by editUrl + relativeDocPath. 使用函数可以允许你更精细地控制每一个文件。 完全忽略这个变量就会禁用编辑链接。
editLocalizedFiles	boolean	false	编辑 URL 会指向本地化的文件，而不是原始的未翻译文件。 Ignored when editUrl is a function.
editCurrentVersion	boolean	false	编辑 URL 会永远指向当前版本文档而不是历史版本。 Ignored when editUrl is a function.
routeBasePath	string	'docs'	站点文档部分的 URL 前缀。 DO NOT include a trailing slash. Use / for shipping docs without base path.
tagsBasePath	string	'tags'	站点标签列表部分的 URL 前缀。 It is prepended to the routeBasePath.
include	string[]	['**/*.{md,mdx}']	相对于内容路径的 glob 模式列表，匹配到的 Markdown 文件会被构建。
exclude	string[]	See example configuration	Glob 模式列表，匹配到的 Markdown 文件会被排除。 Serves as refinement based on the include option.
sidebarPath	false | string	undefined	Path to a sidebars configuration file, loaded in a Node.js context. Use false to disable sidebars, or undefined to create a fully autogenerated sidebar.
sidebarCollapsible	boolean	true	侧边栏类别是否默认可折叠。 See also Collapsible categories
sidebarCollapsed	boolean	true	侧边栏类别是否默认被折叠。 See also Expanded categories by default
sidebarItemsGenerator	SidebarGenerator	Omitted	Function used to replace the sidebar items of type 'autogenerated' with real sidebar items (docs, categories, links...). See also Customize the sidebar items generator
numberPrefixParser	boolean | PrefixParser	Omitted	自定义从文件名中提取数字前缀的逻辑。 Use false to disable this behavior and leave the docs untouched, and true to use the default parser. See also Using number prefixes
docsRootComponent	string	'@theme/DocsRoot'	Parent component of all the docs plugin pages (including all versions). Stays mounted when navigation between docs pages and versions.
docVersionRootComponent	string	'@theme/DocVersionLayout'	Parent component of all docs pages of an individual version (doc pages with sidebars, tags pages). Stays mounted when navigation between pages of that specific version.
docRootComponent	string	'@theme/DocRoot'	Parent component of all doc pages with sidebars (regular docs pages, category generated index pages). Stays mounted when navigation between such pages.
docItemComponent	string	'@theme/DocItem'	文档主容器，包括了目录、页面导航等。
docTagsListComponent	string	'@theme/DocTagsListPage'	标签列表页的根组件
docTagDocListComponent	string	'@theme/DocTagDocListPage'	「包含某标签的所有文档」页面的根组件。
docCategoryGeneratedIndexComponent	string	'@theme/DocCategoryGeneratedIndexPage'	自动生成类别索引页的根组件。
remarkPlugins	any[]	[]	传递给 MDX 的 Remark 插件。
rehypePlugins	any[]	[]	传递给 MDX 的 Rehype 插件。
rehypePlugins	any[]	[]	Recma plugins passed to MDX.
beforeDefaultRemarkPlugins	any[]	[]	在 Docusaurus 默认 Remark 插件之前传递给 MDX 的自定义 Remark 插件。
beforeDefaultRehypePlugins	any[]	[]	在 Docusaurus 默认 Rehype 插件之前传递给 MDX 的自定义 Rehype 插件。
showLastUpdateAuthor	boolean	false	是否显示最后更新文档的作者。
showLastUpdateTime	boolean	false	Whether to display the last date the doc was updated. This requires access to git history during the build, so will not work correctly with shallow clones (a common default for CI systems). With GitHub actions/checkout, usefetch-depth: 0.
breadcrumbs	boolean	true	在文档页面上启用或禁用面包屑导航。
disableVersioning	boolean	false	即使存在多个版本，也明确禁用分版功能。 这会让网站只包含当前版本。 Will error if includeCurrentVersion: false and disableVersioning: true.
includeCurrentVersion	boolean	true	包含文档的当前版本。
lastVersion	string	First version in versions.json	文档类的导航栏项会默认显示并跳转到的文档版本。
onlyIncludeVersions	string[]	所有版本	只包含所有可用版本中的一个子集。
versions	VersionsConfig	{}	独立自定义每个版本的属性。
tags	string | false | null | undefined	tags.yml	Path to a YAML file listing pre-defined tags. Relative to the docs version content directories.
onInlineTags	'ignore' | 'log' | 'warn' | 'throw'	warn	The plugin behavior when docs contain inline tags (not appearing in the list of pre-defined tags, usually docs/tags.yml).

类型

EditUrlFunction

type EditUrlFunction = (params: {
  version: string;
  versionDocsDirPath: string;
  docPath: string;
  permalink: string;
  locale: string;
}) => string | undefined;

PrefixParser

type PrefixParser = (filename: string) => {
  filename: string;
  numberPrefix?: number;
};

SidebarGenerator

type SidebarGenerator = (generatorArgs: {
  /** The sidebar item with type "autogenerated" to be transformed. */
  item: