# 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.

> **Note**: This application is a fork of [AriaDocs](https://github.com/nisabmohd/Aria-Docs), created by [Nisab Mohd](https://github.com/nisabmohd). DocuBook provides an alternative to the documentation solution found on [Mintlify](https://mintlify.com/), utilizing `.mdx` (Markdown + JSX) for content creation and management.

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/import/project?template=https://github.com/mywildancloud/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
```

## Update
### How to Update DocuBook?
- **Open a New Terminal**: Please open a new terminal on the desktop that has DocuBook installed.
- **Move Directory**: for example, if the directory name is docubook, then write `cd docubook` and press enter.

```bash
npx @docubook/update@latest
```

#### command output

```bash
📂 Updating Docubook project in /Users/wildan/Public/docubook...

ℹ ⚡ Skipped public
ℹ ⚡ Skipped contents
ℹ ⚡ Skipped app/page.tsx
ℹ ⚡ Skipped docu.json
ℹ ⚡ Skipped CHANGELOG.md
✨ Replacing styles folder...
✨ Replaced all CSS files in styles folder
✔ ✅ Docubook v1.4.2 successfully updated in /Users/wildan/Public/docubook!

🎯 Next steps:
1. Verify your changes in the current directory.
2. Run the install script to check for package updates:
   npm install
3. Run the development server:
   npm run dev
```

Access the app on => http://localhost:3000