Skip to content

Commit 1bc7a1a

Browse files
committed
Rename .objectdocs to .fumadocs across the project for consistency
1 parent f9fdd45 commit 1bc7a1a

File tree

22 files changed

+81
-81
lines changed

22 files changed

+81
-81
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ next-env.d.ts
3737
.next
3838

3939
# objectdocs
40-
content/.objectdocs
40+
content/.fumadocs
4141

4242
# test artifacts
4343
/tmp/objectdocs-test-*

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ test-full:
3939
clean:
4040
rm -rf node_modules
4141
rm -rf .next
42-
rm -rf content/.objectdocs
42+
rm -rf content/.fumadocs
4343
rm -rf packages/*/node_modules
4444
rm -rf examples/*/node_modules
4545
find . -name ".next" -type d -exec rm -rf {} + 2>/dev/null || true

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -65,10 +65,10 @@ npx @objectdocs/cli init
6565
```
6666

6767
This will:
68-
- Copy the site engine from `@objectdocs/site` to `content/.objectdocs`
68+
- Copy the site engine from `@objectdocs/site` to `content/.fumadocs`
6969
- Create `content/package.json` with scripts (`dev`, `build`, `start`)
70-
- Install dependencies in `content/.objectdocs`
71-
- Automatically add `content/.objectdocs` and `content/node_modules` to `.gitignore`
70+
- Install dependencies in `content/.fumadocs`
71+
- Automatically add `content/.fumadocs` and `content/node_modules` to `.gitignore`
7272
- Keep your project root clean and unpolluted
7373

7474
Then add content and start the server:
@@ -119,23 +119,23 @@ ObjectDocs enforces a clear directory structure to ensure maintainability at sca
119119
.
120120
├── content/ # [Data Layer] All documentation files
121121
│ ├── package.json # Scripts: dev, build, start (created by init)
122-
│ ├── .objectdocs/ # Site engine (copied from @objectdocs/site, gitignored)
122+
│ ├── .fumadocs/ # Site engine (copied from @objectdocs/site, gitignored)
123123
│ │ ├── node_modules/ # Dependencies (installed during init)
124124
│ │ ├── .next/ # Next.js build cache (development)
125125
│ │ └── out/ # Static build output (production)
126126
│ ├── docs.site.json # Global config (Nav, Logo, Branding, i18n)
127127
│ └── docs/
128128
│ ├── meta.json # Directory structure & page order
129129
│ └── index.mdx # Documentation content
130-
├── out/ # Final build output (copied from content/.objectdocs/out)
130+
├── out/ # Final build output (copied from content/.fumadocs/out)
131131
├── package.json # (Optional) Root project package.json
132132
└── ...
133133
```
134134

135135
**Key Points:**
136136
- All documentation-related files are in `content/`
137-
- `content/.objectdocs/` contains the complete Next.js site engine (auto-generated, gitignored)
138-
- Build output: `content/.objectdocs/out` → copied to root `out/` directory
137+
- `content/.fumadocs/` contains the complete Next.js site engine (auto-generated, gitignored)
138+
- Build output: `content/.fumadocs/out` → copied to root `out/` directory
139139
- Your project root remains clean
140140
- Perfect for adding docs to any existing project
141141

@@ -170,7 +170,7 @@ Manage global navigation, branding, i18n, and feature flags:
170170
**Supported Features:**
171171
- 14 languages for internationalization
172172
- Automatic config watching and hot reload during development
173-
- Config is copied to `content/.objectdocs` before each build/dev command
173+
- Config is copied to `content/.fumadocs` before each build/dev command
174174

175175
### Sidebar Control (`content/**/meta.json`)
176176

TESTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -188,15 +188,15 @@ pnpm add -D ../../packages/cli/objectdocs-cli-X.X.X.tgz
188188
When preparing for a release, manually verify:
189189

190190
### Development Workflow
191-
- [ ] `pnpm objectdocs init` creates `.objectdocs` directory
191+
- [ ] `pnpm objectdocs init` creates `.fumadocs` directory
192192
- [ ] `pnpm dev` starts development server on port 7777
193193
- [ ] Hot reload works when editing MDX files
194194
- [ ] Hot reload works when editing `meta.json`
195195
- [ ] Hot reload works when editing `docs.site.json`
196196

197197
### Build Process
198198
- [ ] `pnpm build` completes without errors
199-
- [ ] Build output is created in `content/.objectdocs/.next`
199+
- [ ] Build output is created in `content/.fumadocs/.next`
200200
- [ ] No TypeScript errors
201201
- [ ] No ESLint errors (if configured)
202202

content/docs/getting-started/architecture.cn.mdx

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ ObjectDocs 建立在严格的 **关注点分离 (Separation of Concerns)** 理
3636
.
3737
├── content/ # [数据层] 所有文档文件
3838
│ ├── package.json # 脚本: dev, build, start (由 init 创建)
39-
│ ├── .objectdocs/ # 站点引擎 (从 @objectdocs/site 复制, gitignored)
39+
│ ├── .fumadocs/ # 站点引擎 (从 @objectdocs/site 复制, gitignored)
4040
│ │ ├── node_modules/ # 依赖 (初始化时安装)
4141
│ │ ├── .next/ # Next.js 构建缓存 (开发)
4242
│ │ └── out/ # 静态构建输出 (生产)
@@ -45,44 +45,44 @@ ObjectDocs 建立在严格的 **关注点分离 (Separation of Concerns)** 理
4545
│ └── docs/
4646
│ ├── meta.json # 目录结构 & 页面顺序
4747
│ └── index.mdx # 文档内容
48-
├── out/ # 最终构建输出 (从 content/.objectdocs/out 复制)
49-
├── .gitignore # 自动更新以排除 content/.objectdocs
48+
├── out/ # 最终构建输出 (从 content/.fumadocs/out 复制)
49+
├── .gitignore # 自动更新以排除 content/.fumadocs
5050
├── package.json # (可选) 根目录 package.json
5151
└── ...
5252
```
5353

5454
**核心组件:**
55-
- **`content/.objectdocs/`**: 包含来自 `@objectdocs/site` 包的完整 Next.js 站点引擎
55+
- **`content/.fumadocs/`**: 包含来自 `@objectdocs/site` 包的完整 Next.js 站点引擎
5656
- **`content/package.json`**: 由 init 命令创建,包含 dev/build/start 脚本
57-
- **构建流程**: `content/.objectdocs/out``out/` (根目录)
58-
- **环境**: 命令在 `content/.objectdocs` 内运行,`DOCS_DIR` 环境变量指向文档目录
57+
- **构建流程**: `content/.fumadocs/out``out/` (根目录)
58+
- **环境**: 命令在 `content/.fumadocs` 内运行,`DOCS_DIR` 环境变量指向文档目录
5959

6060
## 数据流向
6161

6262
### 初始化流程
6363
1. **初始化命令**: `npx @objectdocs/cli init`
64-
2. **包复制**: 整个 `@objectdocs/site` 包 → `content/.objectdocs`
64+
2. **包复制**: 整个 `@objectdocs/site` 包 → `content/.fumadocs`
6565
3. **脚本创建**: 创建 `content/package.json` 并添加 dev/build/start 脚本
66-
4. **依赖安装**: 在 `content/.objectdocs` 中运行 `npm install`
66+
4. **依赖安装**: 在 `content/.fumadocs` 中运行 `npm install`
6767
5. **Gitignore 更新**: 添加排除生成文件的规则
6868

6969
### 开发流程
7070
1. **启动**: 运行 `cd content && npm run dev`
71-
2. **配置同步**: 复制 `docs.site.json``public/``content/.objectdocs`
71+
2. **配置同步**: 复制 `docs.site.json``public/``content/.fumadocs`
7272
3. **环境**: 设置 `DOCS_DIR` 环境变量指向 `content/docs`
7373
4. **监听**: 监控 `docs.site.json` 的变化并自动重启
7474
5. **服务器**: Next.js 开发服务器在端口 7777 上运行(默认)
7575

7676
### 构建流程
7777
1. **构建时**: 运行 `cd content && npm run build`
78-
2. **配置同步**: 复制 `docs.site.json``public/``content/.objectdocs`
78+
2. **配置同步**: 复制 `docs.site.json``public/``content/.fumadocs`
7979
3. **环境**: 设置 `DOCS_DIR` 环境变量
8080
4. **MDX 解析**: Fumadocs 从 `DOCS_DIR` 读取所有 `.mdx` 文件
8181
5. **元数据**: 解析 `meta.json` 文件构建导航树
8282
6. **渲染**: Next.js App Router 将内容渲染为 React Server Components
8383
7. **输出**:
84-
- 静态模式: `content/.objectdocs/out``out/` (根目录)
85-
- 动态模式: `content/.objectdocs/.next``.next/` (根目录)
84+
- 静态模式: `content/.fumadocs/out``out/` (根目录)
85+
- 动态模式: `content/.fumadocs/.next``.next/` (根目录)
8686

8787
### 运行流程 (静态)
8888
1. **服务**: 从 `out/` 目录提供生产构建

content/docs/getting-started/architecture.mdx

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ A standard ObjectDocs project structure after initialization:
3636
.
3737
├── content/ # [Data Layer] All documentation files
3838
│ ├── package.json # Scripts: dev, build, start (created by init)
39-
│ ├── .objectdocs/ # Site engine (copied from @objectdocs/site, gitignored)
39+
│ ├── .fumadocs/ # Site engine (copied from @objectdocs/site, gitignored)
4040
│ │ ├── node_modules/ # Dependencies (installed during init)
4141
│ │ ├── .next/ # Next.js build cache (development)
4242
│ │ └── out/ # Static build output (production)
@@ -45,44 +45,44 @@ A standard ObjectDocs project structure after initialization:
4545
│ └── docs/
4646
│ ├── meta.json # Directory structure & page order
4747
│ └── index.mdx # Documentation content
48-
├── out/ # Final build output (copied from content/.objectdocs/out)
49-
├── .gitignore # Auto-updated to exclude content/.objectdocs
48+
├── out/ # Final build output (copied from content/.fumadocs/out)
49+
├── .gitignore # Auto-updated to exclude content/.fumadocs
5050
├── package.json # (Optional) Root project package.json
5151
└── ...
5252
```
5353

5454
**Key Components:**
55-
- **`content/.objectdocs/`**: Contains the complete Next.js site engine from `@objectdocs/site` package
55+
- **`content/.fumadocs/`**: Contains the complete Next.js site engine from `@objectdocs/site` package
5656
- **`content/package.json`**: Created by init command with dev/build/start scripts
57-
- **Build Flow**: `content/.objectdocs/out``out/` (root directory)
58-
- **Environment**: Commands run inside `content/.objectdocs` with `DOCS_DIR` env variable pointing to docs
57+
- **Build Flow**: `content/.fumadocs/out``out/` (root directory)
58+
- **Environment**: Commands run inside `content/.fumadocs` with `DOCS_DIR` env variable pointing to docs
5959

6060
## Data Flow
6161

6262
### Initialization Flow
6363
1. **Init Command**: `npx @objectdocs/cli init`
64-
2. **Package Copy**: Entire `@objectdocs/site` package → `content/.objectdocs`
64+
2. **Package Copy**: Entire `@objectdocs/site` package → `content/.fumadocs`
6565
3. **Script Creation**: `content/package.json` with dev/build/start scripts
66-
4. **Dependency Install**: `npm install` in `content/.objectdocs`
66+
4. **Dependency Install**: `npm install` in `content/.fumadocs`
6767
5. **Gitignore Update**: Add exclusions for generated files
6868

6969
### Development Flow
7070
1. **Start**: Run `cd content && npm run dev`
71-
2. **Config Sync**: Copy `docs.site.json` and `public/` to `content/.objectdocs`
71+
2. **Config Sync**: Copy `docs.site.json` and `public/` to `content/.fumadocs`
7272
3. **Environment**: Set `DOCS_DIR` env variable to point to `content/docs`
7373
4. **Watch**: Monitor `docs.site.json` for changes and auto-restart
7474
5. **Server**: Next.js dev server runs on port 7777 (default)
7575

7676
### Build Flow
7777
1. **Build Time**: Run `cd content && npm run build`
78-
2. **Config Sync**: Copy `docs.site.json` and `public/` to `content/.objectdocs`
78+
2. **Config Sync**: Copy `docs.site.json` and `public/` to `content/.fumadocs`
7979
3. **Environment**: Set `DOCS_DIR` env variable
8080
4. **MDX Parsing**: Fumadocs reads all `.mdx` files from `DOCS_DIR`
8181
5. **Metadata**: Parse `meta.json` files to build navigation tree
8282
6. **Rendering**: Next.js App Router renders as React Server Components
8383
7. **Output**:
84-
- Static mode: `content/.objectdocs/out``out/` (root)
85-
- Dynamic mode: `content/.objectdocs/.next``.next/` (root)
84+
- Static mode: `content/.fumadocs/out``out/` (root)
85+
- Dynamic mode: `content/.fumadocs/.next``.next/` (root)
8686

8787
### Runtime Flow (Static)
8888
1. **Serve**: Production build served from `out/` directory

content/docs/getting-started/configuration.cn.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ObjectDocs 遵循 **配置即代码 (Configuration as Code)** 的原则。所有
1313

1414
### docs.site.json
1515

16-
主配置文件位于 `content/docs.site.json`。该文件控制整个文档站点的全局设置,并在构建和开发期间自动同步到 `content/.objectdocs`
16+
主配置文件位于 `content/docs.site.json`。该文件控制整个文档站点的全局设置,并在构建和开发期间自动同步到 `content/.fumadocs`
1717

1818
```json
1919
{
@@ -37,7 +37,7 @@ ObjectDocs 遵循 **配置即代码 (Configuration as Code)** 的原则。所有
3737

3838
**工作原理:**
3939
- 存储在 `content/docs.site.json` (你的内容目录)
40-
- 在每次 build/dev 命令前复制到 `content/.objectdocs`
40+
- 在每次 build/dev 命令前复制到 `content/.fumadocs`
4141
- 开发时监听 - 变化会触发服务器自动重启
4242
- 支持 14 种语言的国际化
4343

content/docs/getting-started/configuration.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ObjectDocs follows the **Configuration as Code** principle. All site settings ar
1313

1414
### docs.site.json
1515

16-
The main configuration file is located at `content/docs.site.json`. This file controls the global settings for the entire documentation site and is automatically synced to `content/.objectdocs` during build and development.
16+
The main configuration file is located at `content/docs.site.json`. This file controls the global settings for the entire documentation site and is automatically synced to `content/.fumadocs` during build and development.
1717

1818
```json
1919
{
@@ -37,7 +37,7 @@ The main configuration file is located at `content/docs.site.json`. This file co
3737

3838
**How it Works:**
3939
- Stored in `content/docs.site.json` (your content directory)
40-
- Copied to `content/.objectdocs` before each build/dev command
40+
- Copied to `content/.fumadocs` before each build/dev command
4141
- Watched during development - changes trigger automatic server restart
4242
- Supports 14 languages for internationalization
4343

content/docs/getting-started/index.cn.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,10 @@ npx @objectdocs/cli init
4141
```
4242

4343
这将:
44-
-`@objectdocs/site` 复制站点引擎到 `content/.objectdocs`
44+
-`@objectdocs/site` 复制站点引擎到 `content/.fumadocs`
4545
- 创建 `content/package.json` 并添加脚本 (`dev`, `build`, `start`)
46-
-`content/.objectdocs` 中安装依赖
47-
-`content/.objectdocs``content/node_modules` 添加到 `.gitignore`
46+
-`content/.fumadocs` 中安装依赖
47+
-`content/.fumadocs``content/node_modules` 添加到 `.gitignore`
4848
- 保持项目根目录整洁
4949

5050
### 创建内容目录

content/docs/getting-started/index.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,10 @@ npx @objectdocs/cli init
4141
```
4242

4343
This will:
44-
- Copy the site engine from `@objectdocs/site` to `content/.objectdocs`
44+
- Copy the site engine from `@objectdocs/site` to `content/.fumadocs`
4545
- Create `content/package.json` with scripts (`dev`, `build`, `start`)
46-
- Install dependencies in `content/.objectdocs`
47-
- Add `content/.objectdocs` and `content/node_modules` to `.gitignore`
46+
- Install dependencies in `content/.fumadocs`
47+
- Add `content/.fumadocs` and `content/node_modules` to `.gitignore`
4848
- Keep your project root clean
4949

5050
### Create Content Directory

0 commit comments

Comments
 (0)