|
| 1 | +# Object UI Documentation Site |
| 2 | + |
| 3 | +This is the official documentation site for Object UI, built with [Fumadocs](https://fumadocs.vercel.app/). |
| 4 | + |
| 5 | +## Development |
| 6 | + |
| 7 | +```bash |
| 8 | +# Install dependencies |
| 9 | +pnpm install |
| 10 | + |
| 11 | +# Start development server |
| 12 | +pnpm dev |
| 13 | + |
| 14 | +# Build for production |
| 15 | +pnpm build |
| 16 | + |
| 17 | +# Start production server |
| 18 | +pnpm start |
| 19 | +``` |
| 20 | + |
| 21 | +## Project Structure |
| 22 | + |
| 23 | +``` |
| 24 | +apps/site/ |
| 25 | +├── app/ # Next.js app directory |
| 26 | +│ ├── docs/ # Documentation pages |
| 27 | +│ ├── layout.tsx # Root layout |
| 28 | +│ └── page.tsx # Homepage |
| 29 | +├── content/ # MDX documentation content |
| 30 | +│ └── docs/ # Documentation markdown files |
| 31 | +├── lib/ # Library code |
| 32 | +│ └── source.ts # Fumadocs source configuration |
| 33 | +├── public/ # Static assets |
| 34 | +├── next.config.mjs # Next.js configuration |
| 35 | +├── tailwind.config.ts # Tailwind CSS configuration |
| 36 | +└── source.config.ts # Fumadocs MDX configuration |
| 37 | +``` |
| 38 | + |
| 39 | +## Features |
| 40 | + |
| 41 | +- 📝 MDX-based documentation |
| 42 | +- 🎨 Built with Tailwind CSS |
| 43 | +- 🌗 Dark mode support |
| 44 | +- 🔍 Full-text search (coming soon) |
| 45 | +- 📱 Responsive design |
| 46 | +- ⚡ Fast page loads with Next.js |
| 47 | + |
| 48 | +## Adding Documentation |
| 49 | + |
| 50 | +1. Create a new `.mdx` file in `content/docs/` |
| 51 | +2. Add frontmatter with title and description: |
| 52 | + ```mdx |
| 53 | + --- |
| 54 | + title: Your Page Title |
| 55 | + description: Page description |
| 56 | + --- |
| 57 | + |
| 58 | + # Your Content Here |
| 59 | + ``` |
| 60 | +3. Update `content/docs/meta.json` to add the page to navigation |
| 61 | + |
| 62 | +## Tech Stack |
| 63 | + |
| 64 | +- [Next.js 15](https://nextjs.org/) - React framework |
| 65 | +- [Fumadocs](https://fumadocs.vercel.app/) - Documentation framework |
| 66 | +- [Tailwind CSS](https://tailwindcss.com/) - Styling |
| 67 | +- [TypeScript](https://www.typescriptlang.org/) - Type safety |
0 commit comments