配置
Check the docusaurus.config.js
API reference for an exhaustive list of options.
Docusaurus 对配置文件有着独特见解。 我们鼓励你将站点信息集中到一处。 我们会维护这个文件的每个字段,你可以在站点的任何地方访问数据对象。
悉心维护的 docusaurus.config.js
能够让你在个性化站点的同时,帮助你、你的协作者、以及开源项目贡献者专注于文档本身。
Syntax to declare docusaurus.config.js
The docusaurus.config.js
file is run in Node.js and should export either:
- a config object
- a function that creates the config object
The docusaurus.config.js
file only supports the CommonJS module system:
- Required: use
module.exports = /* your config*/
to export your Docusaurus config - Optional: use
require("lib")
to import Node.js packages - Optional: use
await import("lib")
(dynamic import) in an async function to import ESM-Only Node.js packages
Node.js gives us the ability to declare our Docusaurus configuration in various equivalent ways, and all the following config examples lead to the exact same result:
module.exports = {
title: 'Docusaurus',
url: 'https://docusaurus.io',
// your site config ...
};
const config = {
title: 'Docusaurus',
url: 'https://docusaurus.io',
// your site config ...
};
module.exports = config;
module.exports = function configCreator() {
return {
title: 'Docusaurus',
url: 'https://docusaurus.io',
// your site config ...
};
};
module.exports = async function createConfigAsync() {
return {
title: 'Docusaurus',
url: 'https://docusaurus.io',
// your site config ...
};
};
Using an async config creator can be useful to import ESM-only modules (notably most Remark plugins). It is possible to import such modules thanks to dynamic imports:
module.exports = async function createConfigAsync() {
// Use a dynamic import instead of require('esm-lib')
const lib = await import('lib');
return {
title: 'Docusaurus',
url: 'https://docusaurus.io',
// rest of your site config...
};
};
docusaurus.config.js
里会写什么?
即便你正在开发网站,你也没必要从零开始撰写 docusaurus.config.js
。 所有模板都自带了一个 docusaurus.config.js
,包含常见选项的默认值。
但是,深入了解配置是如何设计与实现的也会很有帮助。
从高维度来说,Docusaurus 配置可被分为这几类: