Obsidian

实验性的

可能存在漏洞或破坏性更改，请自行承担风险使用。

安装

🌐 Setup

npm i fumadocs-obsidian

你可以将你的保险库文件夹复制到项目中（例如，根目录）：

🌐 You can copy your vault folder to the project (e.g. root directory):

Introduction.md

Folder/Hello World.md

package.json

创建一个脚本来生成文档和资源：

🌐 Create a script to generate docs & assets:

scripts/generate.ts

import { fromVault } from 'fumadocs-obsidian';

await fromVault({
  dir: 'Obsidian Vault',
  out: {
    // you can specify the locations of `/public` & `/content/docs` folder
  },
});

运行脚本以生成文档：

🌐 Run the script to generate docs:

bun scripts/generate.ts

最后，包含必要的 MDX 组件：

🌐 Finally, include necessary MDX components:

mdx-components.tsx

import defaultMdxComponents from 'fumadocs-ui/mdx';
import * as ObsidianComponents from 'fumadocs-obsidian/ui';
import type { MDXComponents } from 'mdx/types';

export function getMDXComponents(components?: MDXComponents) {
  return {
    ...defaultMdxComponents,
    ...ObsidianComponents,
    ...components,
  };
}

附加项

🌐 Additions

某些语法特性需要单独启用：

🌐 Some syntax features need to be enabled separately:

Mermaid。
数学。

安装

附加项

On this page