配置

类似 VuePress，我们可以在项目的根目录创建 .onepress 目录，在这里面可以新建 config.js 或 config.ts 文件作为配置文件：

js
<root>/.onepress/config.js
1export default {
2  // ...
3};

如果要获得类型提示，可以从 onepress 中导入 defineConfig 方法：

js
1import { defineConfig } from 'onepress';
2
3export default defineConfig({
4  // ...
5});

src

默认情况下 OnePress 会扫描 docs 目录下特定后缀的文件作为文档内容，并以此生成路由规则。后缀列表如下：

• .md
• .mdx
• .page.js
• .page.jsx
• .page.ts
• .page.tsx

如果想修改目录或修改扫描规则，可以使用 src 字段，例如：

js
1export default {
2  src: 'content', // 指定 content 为文档目录
3};

ignored

可以通过 ignored 字段忽略扫描特定的文件：

js
1export default {
2  ignored: 'test.mdx', // 忽略 test.mdx 文件
3};

themeConfig

通过 themeConfig 字段配置主题，例如：

js
1export default {
2  themeConfig: {
3    title: 'My App',
4  },
5};

Note: themeConfig 可配置的内容是由使用的主题来决定的。不同主题往往对应着不同的配置项。

vite

通过 vite 修改 Vite 的配置，例如：

js
1export default {
2  vite: {
3    base: '/app/',
4    outDir: 'output',
5  },
6};

react

@vitejs/plugin-react的配置。

mdx

通过 mdx 字段设置 mdx 的 plugins，例如：

js
1export default {
2  mdx: {
3    remarkPlugins: [require('remark-toc')],
4  },
5};

tailwind

默认情况下 OnePress 会读取项目根目录下的 tailwind.config.js 内容作为 tailwind 的配置。

如果想使用别的文件名作为 tailwind 配置文件，可以通过 tailwind 字段来设置：

js
1export default {
2  tailwind: 'my-tailwind.config.js',
3};

也可以直接在这个字段里写配置内容，例如：

js
1export default {
2  tailwind: {
3    theme: {
4      extend: {
5        colors: {
6          primary: '#3eaf7c',
7        },
8      },
9    },
10  },
11};

icons

unplugin-icons 的配置项。