refactor: docubook@latest template nextjs-docker
This commit is contained in:
54
README.md
54
README.md
@@ -1,37 +1,45 @@
|
||||
# DocuBook
|
||||
# DocuBook — Next.js (Docker)
|
||||
|
||||
**DocuBook** is a documentation web project designed to provide a simple and user-friendly interface for accessing various types of documentation. This site is crafted for developers and teams who need quick access to references, guides, and essential documents.
|
||||
|
||||
[](https://vercel.com/import/project?template=https://github.com/DocuBook/docubook)
|
||||
A documentation starter template with a **production-ready Docker setup** using multi-stage builds and Next.js standalone output. Designed for self-hosted and containerized environments.
|
||||
|
||||
## Features
|
||||
|
||||
- **Easy Navigation**: Simple layout for quick navigation between pages.
|
||||
- **Quick Search**: Easily find documentation using a search function.
|
||||
- **Responsive Theme**: Responsive design optimized for devices ranging from desktops to mobile.
|
||||
- **Markdown Content**: Support for markdown-based documents.
|
||||
- **SEO Friendly**: Optimized structure for search visibility, enhancing accessibility on search engines.
|
||||
- **Multi-stage Dockerfile** — build stage compiles, production stage runs on minimal Alpine base
|
||||
- **Standalone Output** — only runtime artifacts in the final image (~100MB vs ~1GB full node_modules)
|
||||
- **Container-native** — single-process design compatible with any orchestrator
|
||||
- **Platform-agnostic** — works with Coolify, Kubernetes, Railway, Fly.io, Render, or any Docker host
|
||||
- **MDX Content** — write documentation in Markdown/MDX with full component support
|
||||
- **SEO Friendly** — automatic sitemap, meta tags, and structured data
|
||||
- **Responsive Design** — optimized for desktop and mobile devices
|
||||
- **Quick Search** — fast client-side documentation search
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npx @docubook/create@latest
|
||||
npx @docubook/cli@latest
|
||||
```
|
||||
|
||||
#### command output
|
||||
|
||||

|
||||
|
||||
---
|
||||
|
||||
## Deployment
|
||||
|
||||
Build and run the Docker image:
|
||||
|
||||
```bash
|
||||
? Enter a name for your project directory: (docubook)
|
||||
|
||||
Creating a new Docubook project in /path/your/docubook from the main branch...
|
||||
✔ Docubook project successfully created in /path/your/docubook!
|
||||
|
||||
Next steps:
|
||||
1. Navigate to your project directory:
|
||||
cd docubook
|
||||
2. Install dependencies:
|
||||
npm install
|
||||
3. Start the development server:
|
||||
npm run dev
|
||||
docker build -t docubook:latest .
|
||||
docker run -p 3000:3000 -e NODE_ENV=production docubook:latest
|
||||
```
|
||||
|
||||
### Platform notes
|
||||
|
||||
| Platform | Notes |
|
||||
|----------|-------|
|
||||
| **Coolify / Docker VPS** | Push image to registry, deploy as standard container (PORT=3000) |
|
||||
| **Kubernetes** | Create Deployment + Service; image runs single process on PORT |
|
||||
| **Railway / Fly.io / Render** | Auto-detected from Dockerfile; set env vars via provider panel |
|
||||
|
||||
For Vercel deployment (no Docker needed), use the [`nextjs`](../nextjs) template instead.
|
||||
|
||||
Reference in New Issue
Block a user