Obsidian

实验性

可能存在 bug 或破坏性变更，请自行承担风险。

设置

npm i fumadocs-obsidian

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

Introduction.md

Folder/Hello World.md

package.json

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

scripts/generate.ts

import { fromVault } from 'fumadocs-obsidian';

await fromVault({
  dir: 'Obsidian Vault',
  out: {
    // 你可以指定 `/public` 和 `/content/docs` 文件夹的位置
  },
});

运行脚本生成文档：

bun scripts/generate.ts

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

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,
  };
}

附加

某些语法功能需要单独启用：

Mermaid。
Math。

设置

附加

On this page