38 lines
1.2 KiB
Markdown
38 lines
1.2 KiB
Markdown
# DocuBook
|
|
|
|
**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)
|
|
|
|
## 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.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
npx @docubook/create@latest
|
|
```
|
|
|
|
#### command output
|
|
|
|
```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
|
|
```
|