我和我的团队正在寻求实现一个文档系统,该系统允许工程师将 markdown 文件放入每个服务根目录的指定文件夹中。由于我们处于单一存储库中,我们希望有一个过程来遍历并聚合所有必要的 Markdown 文件并静态生成最终站点。
我们很乐意使用 Docusaurus 来处理这项任务;但是,我们遇到了一个问题,它似乎无法提供“安装”目录之外的文件(其配置所在/调用的位置)。
示例目录:
/docs/ <- docusaurus is in this folder
/service/_docs <- these are the markdown files we'd like to pull from
Docusaurus 能够 (a) 解析路径 (b) 写入 json 元数据文件。我可以这么说,因为我添加了日志记录 + 我看到了在 .docusaurus 文件夹中生成的 .json 文件。
我们正在使用插件内容文档,并且希望避免编写我们自己的插件:
[
'@docusaurus/plugin-content-docs',
{
id: 'foo',
path: path.resolve(__dirname, '..', 'service', '_docs'),
routeBasePath: 'service'
},
],
我认为这是你需要根据Docusaurus docs配置的:
module.exports = {
presets: [
[
'@docusaurus/preset-classic',
{
docs: {
// id: 'default', // omitted => default instance
path: 'docs',
routeBasePath: '/',
// ... other options
},
},
],
],
plugins: [
[
'@docusaurus/plugin-content-docs',
{
id: 'service',
path: '../service/docs', // <<-- relative path from the docusaurus folder
routeBasePath: 'docs/service',
// ... other options
},
],
],
};