File tree Expand file tree Collapse file tree 7 files changed +140
-0
lines changed
Expand file tree Collapse file tree 7 files changed +140
-0
lines changed Original file line number Diff line number Diff line change 1+ node_modules
2+ .next
3+ out
4+ .env
5+ .DS_Store
Original file line number Diff line number Diff line change 1+ # ObjectDocs Starter Template
2+
3+ This is a starter template for creating documentation sites with [ ObjectDocs] ( https://github.com/steedos/objectdocs ) . It comes pre-configured with the necessary directory structure and dependencies to get you started quickly.
4+
5+ ## Features
6+
7+ - ** Configuration as Code** : Manage site navigation and settings via JSON.
8+ - ** MDX Support** : Write content using Markdown mixed with React components.
9+ - ** Live Preview** : Fast development server with hot reload.
10+ - ** Production Ready** : Optimized static build output.
11+
12+ ## Getting Started
13+
14+ ### 1. Installation
15+
16+ Install the dependencies:
17+
18+ ``` bash
19+ pnpm install
20+ ```
21+
22+ ### 2. Development
23+
24+ Start the development server:
25+
26+ ``` bash
27+ pnpm docs:dev
28+ ```
29+
30+ Open [ http://localhost:7777 ] ( http://localhost:7777 ) in your browser to see the result.
31+
32+ ### 3. Building
33+
34+ Build the static site for production:
35+
36+ ``` bash
37+ pnpm docs:build
38+ ```
39+
40+ The output will be in the ` .next ` or configured output directory.
41+
42+ ## Project Structure
43+
44+ ``` bash
45+ .
46+ ├── content/
47+ │ ├── docs.site.json # Global site configuration (branding, nav links)
48+ │ └── docs/ # Documentation content root
49+ │ ├── index.mdx # Homepage
50+ │ ├── guide.mdx # Example page
51+ │ └── meta.json # Sidebar navigation order
52+ ├── package.json
53+ └── README.md
54+ ```
55+
56+ ## Customization
57+
58+ - ** Site Name & Logo** : Edit ` content/docs.site.json ` .
59+ - ** Navigation Sidebar** : Edit ` content/docs/meta.json ` or creating new ` meta.json ` files in subdirectories.
60+ - ** Adding Pages** : Create new ` .mdx ` files in ` content/docs/ ` and add them to the relevant ` meta.json ` .
61+
62+ ## License
63+
64+ MIT
Original file line number Diff line number Diff line change 1+ {
2+ "branding" : {
3+ "name" : " ObjectDocs Starter"
4+ },
5+ "links" : [
6+ {
7+ "text" : " Home" ,
8+ "url" : " /"
9+ },
10+ {
11+ "text" : " GitHub" ,
12+ "url" : " https://github.com" ,
13+ "icon" : " github"
14+ }
15+ ]
16+ }
Original file line number Diff line number Diff line change 1+ ---
2+ title : User Guide
3+ description : Detailed guide for users
4+ ---
5+
6+ # User Guide
7+
8+ This is a sample guide page.
9+
10+ ## Features
11+
12+ - ** MDX Support** : Write content using Markdown and React components.
13+ - ** Fast Refresh** : Instant feedback during development.
14+ - ** Built on Next.js** : Leveraging the power of React Server Components.
15+
16+ ## Next Steps
17+
18+ Try creating a new file in ` content/docs/ ` folder.
Original file line number Diff line number Diff line change 1+ ---
2+ title : Welcome
3+ description : Your new ObjectDocs site
4+ ---
5+
6+ # Welcome to ObjectDocs
7+
8+ This is a starter template for your documentation site.
9+
10+ ## Getting Started
11+
12+ Edit this file in ` content/docs/index.mdx ` to see changes.
13+
14+ <Cards >
15+ <Card title = " Read the Guide" href = " /docs/guide" description = " Learn how to use ObjectDocs" />
16+ <Card title = " Configuration" href = " /docs/config" description = " Customize your site" />
17+ </Cards >
Original file line number Diff line number Diff line change 1+ {
2+ "title" : " Documentation" ,
3+ "pages" : [
4+ " index" ,
5+ " guide"
6+ ]
7+ }
Original file line number Diff line number Diff line change 1+ {
2+ "name" : " objectdocs-starter" ,
3+ "version" : " 0.1.0" ,
4+ "private" : true ,
5+ "scripts" : {
6+ "docs:dev" : " objectdocs dev" ,
7+ "docs:build" : " objectdocs build" ,
8+ "docs:start" : " objectdocs start"
9+ },
10+ "devDependencies" : {
11+ "@objectdocs/cli" : " workspace:*"
12+ }
13+ }
You can’t perform that action at this time.
0 commit comments