You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+78-52Lines changed: 78 additions & 52 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,98 +33,127 @@
33
33
**ObjectDocs** is a modern, metadata-driven documentation engine architected for the **ObjectStack** ecosystem. Built on top of **Next.js 14 (App Router)** and **Fumadocs**, it redefines how enterprise documentation is maintained.
34
34
35
35
Unlike traditional static site generators, ObjectDocs adopts a strict **Separation of Concerns** philosophy:
36
-
***Presentation**: Handled by a standardized, logic-free React layer.
37
-
***Configuration**: Defined purely in JSON (`site.json`, `meta.json`).
36
+
***Presentation**: Handled by a standardized, logic-free React layer provided by `@objectdocs/site`.
37
+
***Configuration**: Defined purely in JSON (`docs.site.json`, `meta.json`).
38
38
***Content**: Written in MDX with native support for low-code components.
39
39
40
40
This architecture allows developers and technical writers to manage complex, multi-product documentation sites without touching a single line of UI code.
41
41
42
42
## ✨ Key Features
43
43
44
44
***🚀 Metadata-Driven Architecture**
45
-
Control navigation, sidebars, SEO, and branding entirely via `objectdocs.json` and local `meta.json` files. Zero React knowledge required for content maintainers.
45
+
Control navigation, sidebars, SEO, and branding entirely via `docs.site.json` and local `meta.json` files. Zero React knowledge required for content maintainers.
46
46
47
47
***🧩 Low-Code Native**
48
-
Seamlessly embed live, interactive **Amis** and **Steedos**components directly within your Markdown. Perfect for showcasing live demos of low-code configurations.
48
+
Seamlessly embed live, interactive components directly within your Markdown.
49
49
50
-
***🗂️ Multi-Product Support**
51
-
Native implementation of "Root Toggle" modes, allowing you to host documentation for multiple products (e.g., `ObjectQL` vs. `ObjectUI`) within a single monorepo and domain.
50
+
***🤖 AI Translation**
51
+
Built-in CLI command to automatically translate documentation using OpenAI.
52
52
53
53
***🎨 Enterprise-Grade UI**
54
54
Polished interface built on **Radix UI** and **Tailwind CSS**, featuring automatic dark mode, spotlight effects, and accessible primitives out of the box.
55
55
56
-
***⚡ Edge Performance**
57
-
Powered by Next.js App Router and ISR (Incremental Static Regeneration), ensuring instant page loads and excellent SEO.
56
+
## 🚀 Quick Start
58
57
59
-
##🏗️ Architecture
58
+
### 1. Create a new project
60
59
61
-
ObjectDocs enforces a clear directory structure to ensure maintainability at scale:
60
+
Initialize your documentation site structure:
62
61
63
-
```text
64
-
.
65
-
├── content/ # [Data Layer] Raw Content
66
-
│ └── docs/
67
-
│ ├── meta.json # Directory structure & sorting control
68
-
│ └── index.mdx # Documentation content
69
-
├── config/ # [Config Layer]
70
-
│ └── site.json # Global settings (Nav, Logo, Branding)
-**[@objectdocs/cli](./packages/cli)**: The command-line interface for building and developing sites.
180
+
-**[@objectdocs/site](./packages/site)**: The core Next.js application template.
155
181
156
182
## 🤝 Contributing
157
183
158
184
Contributions are welcome! Please read our [Contributing Guide](./CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
159
185
160
186
## 📄 License
161
187
162
-
This project is licensed under the MIT License - see the [LICENSE](https://www.google.com/search?q=MIT) file for details.
188
+
This project is licensed under the MIT License - see the LICENSE file for details.
0 commit comments