@@ -23,24 +23,22 @@ This starter template serves multiple purposes:
2323```
2424examples/starter/
2525├── content/
26- │ ├── package.json # npm scripts (auto-created by init)
27- │ ├── .fumadocs/ # Site engine (created by init command, gitignored)
26+ │ ├── package.json # Project configuration and scripts
27+ │ ├── .fumadocs/ # Site engine (created by init command, gitignored)
2828│ ├── docs.site.json # Global site configuration
29+ │ ├── public/ # Static assets (logos, images)
2930│ └── docs/
3031│ ├── meta.json # Sidebar navigation structure
3132│ ├── index.mdx # Home page
3233│ ├── getting-started.mdx
3334│ └── configuration.mdx
34- ├── public/ # Static assets (logos, images)
35- ├── package.json # Uses @objectdocs/cli from workspace
36- └── README.md # This file
35+ └── README.md # This file
3736```
3837
3938** Key Points:**
40- - All documentation files are in ` content/ `
41- - ` content/package.json ` is auto-created by ` objectdocs init `
39+ - All project files are in ` content/ `
40+ - ` content/package.json ` manages dependencies and scripts
4241- ` content/.fumadocs/ ` is gitignored and not committed
43- - Root directory remains clean
4442
4543## 🚀 Getting Started
4644
@@ -51,44 +49,35 @@ examples/starter/
5149
5250### Installation
5351
54- 1 . Navigate to the starter directory:
52+ 1 . Navigate to the content directory:
5553
5654``` bash
57- cd examples/starter
55+ cd examples/starter/content
5856```
5957
60- 2 . Install the CLI :
58+ 2 . Install dependencies :
6159
6260``` bash
6361pnpm install
6462```
6563
66- This will install ` @objectdocs/cli ` from the workspace.
67-
68643 . Initialize ObjectDocs:
6965
7066``` bash
7167pnpm objectdocs init
7268```
7369
7470This command will:
75- - Create ` content/package.json ` with necessary scripts
76- - Copy the ` @objectdocs/site ` engine to ` content/.fumadocs `
77- - Install dependencies in ` content/.fumadocs/node_modules `
71+ - Copy the ` @objectdocs/site ` engine to ` .fumadocs `
72+ - Install dependencies in ` .fumadocs/node_modules `
7873- Prepare your project for development
7974
8075### Development
8176
8277Start the development server:
8378
8479``` bash
85- cd content && npm run dev
86- ```
87-
88- Or if you have a root-level script configured:
89-
90- ``` bash
91- pnpm dev
80+ npm run dev
9281```
9382
9483The site will be available at [ http://localhost:7777 ] ( http://localhost:7777 ) .
@@ -98,29 +87,17 @@ The site will be available at [http://localhost:7777](http://localhost:7777).
9887Build the project for production:
9988
10089``` bash
101- cd content && npm run build
90+ npm run build
10291```
10392
104- Or with root-level script:
105-
106- ``` bash
107- pnpm build
108- ```
109-
110- This will generate the production build in the ` content/.fumadocs/.next ` directory.
93+ This will generate the production build in the ` .fumadocs/.next ` directory.
11194
11295### Production Server
11396
11497Start the production server:
11598
11699``` bash
117- cd content && npm run start
118- ```
119-
120- Or with root-level script:
121-
122- ``` bash
123- pnpm start
100+ npm run start
124101```
125102
126103## 🌐 Deploying to Vercel
@@ -133,18 +110,18 @@ pnpm start
133110npm i -g vercel
134111```
135112
136- 2 . Deploy from the examples/starter directory:
113+ 2 . Deploy from the content directory:
137114
138115``` bash
139- cd examples/starter
116+ cd examples/starter/content
140117vercel
141118```
142119
143120### Method 2: Using GitHub Integration
144121
1451221 . Push this starter to your GitHub repository
1461232 . Import the project in Vercel
147- 3 . Set the ** Root Directory** to ` examples/starter `
124+ 3 . Set the ** Root Directory** to ` examples/starter/content `
1481254 . Vercel will auto-detect Next.js settings
149126
150127### Vercel Configuration
0 commit comments