Skip to content

Commit 497f3d7

Browse files
authored
Merge pull request #98 from Dokploy/feat/v0.26.0
Feat/v0.26.0
2 parents a729a69 + 6010a49 commit 497f3d7

File tree

230 files changed

+9814
-18294
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

230 files changed

+9814
-18294
lines changed

apps/docs/.gitignore

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
/node_modules
33

44
# generated content
5-
.contentlayer
6-
.content-collections
75
.source
86

97
# test & build

apps/docs/README.md

Lines changed: 111 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,121 @@
1-
# docs-v2
1+
# Dokploy Documentation (New)
22

3-
This is a Next.js application generated with
4-
[Create Fumadocs](https://github.com/fuma-nama/fumadocs).
3+
This is a fresh Fumadocs project with the complete Dokploy documentation migrated from the old docs project.
54

6-
Run development server:
5+
## Features
6+
7+
-**Modern Fumadocs Setup** - Built with the latest Fumadocs version
8+
- 🎨 **Ocean Theme** - Beautiful ocean-themed UI
9+
- 📱 **Responsive Design** - Works perfectly on all devices
10+
- 🔍 **Advanced Search** - Built-in search functionality
11+
- 🌙 **Dark Mode** - Full dark mode support
12+
- 📚 **Complete Documentation** - All docs migrated including:
13+
- Core documentation
14+
- API references
15+
- CLI documentation
16+
- Remote Servers section
17+
- Examples and tutorials
18+
19+
## Getting Started
20+
21+
### Development
22+
23+
Run the development server:
724

825
```bash
9-
npm run dev
10-
# or
26+
# From workspace root
27+
pnpm docs-new:dev
28+
29+
# Or from this directory
1130
pnpm dev
12-
# or
13-
yarn dev
1431
```
1532

16-
Open http://localhost:3000 with your browser to see the result.
33+
The site will be available at `http://localhost:3000`
34+
35+
### Build
36+
37+
Build the documentation for production:
38+
39+
```bash
40+
# From workspace root
41+
pnpm docs-new:build
42+
43+
# Or from this directory
44+
pnpm build
45+
```
46+
47+
### Type Checking
48+
49+
Run type checking:
50+
51+
```bash
52+
# From workspace root
53+
pnpm docs-new:typecheck
54+
55+
# Or from this directory
56+
pnpm run types:check
57+
```
58+
59+
## Structure
60+
61+
```
62+
apps/docs-new/
63+
├── app/ # Next.js app directory
64+
│ ├── (home)/ # Home page
65+
│ ├── docs/ # Documentation pages
66+
│ │ ├── [[...slug]]/ # Dynamic doc pages
67+
│ │ └── layout.tsx # Docs layout
68+
│ ├── api/ # API routes
69+
│ └── layout.tsx # Root layout
70+
├── content/ # MDX documentation content
71+
│ └── docs/ # All documentation files
72+
├── lib/ # Utilities
73+
│ ├── source.ts # Content source configuration
74+
│ └── layout.shared.tsx # Shared layout options
75+
├── public/ # Static assets
76+
└── source.config.ts # Fumadocs configuration
77+
```
78+
79+
## Customization
80+
81+
### Theme
82+
83+
The project uses the **Ocean theme**. To change it, edit `app/global.css`:
84+
85+
```css
86+
@import 'fumadocs-ui/css/ocean.css'; /* Change this to another theme */
87+
```
88+
89+
Available themes: `neutral`, `black`, `vitepress`, `dusk`, `catppuccin`, `ocean`, `purple`
90+
91+
### Layout Configuration
92+
93+
Edit `lib/layout.shared.tsx` to customize:
94+
- Navigation title
95+
- Links
96+
- GitHub URL
97+
- Other layout options
98+
99+
### Content
100+
101+
Add or edit documentation in the `content/docs/` directory. The structure follows Fumadocs conventions with `meta.json` files for navigation.
102+
103+
## Key Differences from Old Docs
104+
105+
1. **Modern API** - Uses `fumadocs-mdx:collections/server` instead of legacy approach
106+
2. **Better Type Safety** - Full TypeScript support with proper types
107+
3. **Simpler Configuration** - Less boilerplate, more conventions
108+
4. **Built-in Features** - Search, OG images, and more work out of the box
109+
5. **No Build Errors** - Clean slate without legacy issues
110+
111+
## Documentation
17112

18-
## Learn More
113+
- [Fumadocs Documentation](https://fumadocs.dev)
114+
- [Fumadocs Themes](https://fumadocs.dev/docs/ui/theme)
115+
- [Fumadocs Layouts](https://fumadocs.dev/docs/ui/blocks/layout)
19116

20-
To learn more about Next.js and Fumadocs, take a look at the following
21-
resources:
117+
## Notes
22118

23-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js
24-
features and API.
25-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
26-
- [Fumadocs](https://fumadocs.vercel.app) - learn about Fumadocs
119+
- The `.source` directory is auto-generated - don't edit it manually
120+
- Run `pnpm run postinstall` after making changes to content structure
121+
- Restart dev server after adding new MDX files

0 commit comments

Comments
 (0)