Fruity Docs

A documentation framework based on Nuxt 3 and DaisyUI, with a MongoDB backend. The project is currently in an early development stage.

Overview

Fruity Docs is a modern, self-hostable documentation framework. It's designed to be easy to use and customize, making it ideal for project documentation, wikis, and knowledge bases. As the project is in its early stages, features are subject to change.

Features

📝 Markdown-Based: Write documentation in Markdown.
🎨 Customizable: Easily themeable with DaisyUI and Tailwind CSS.
🚀 Nuxt 3: Built on the latest version of Nuxt for a great developer experience.
💾 MongoDB Backend: For data persistence.
💡 Early Development: A great time to contribute and shape the project!

Technologies Used

Nuxt 3 – Modern Vue 3 framework
DaisyUI – Clean UI components on Tailwind
Tailwind CSS - A utility-first CSS framework.
MongoDB - NoSQL Database
PM2 – Process manager (recommended for deployment)

Installation

Prerequisites

Node.js (v18+)
NPM
MongoDB
PM2 for production

Steps

Clone the repository:

git clone https://git.weexnes.dev/WeeXnes/fruity-docs.git
cd fruity-docs

Install dependencies:
```
npm install
```
Build the application:
```
npm run build
```
Start the server:
```
pm2 start
```

Configuration

Modify the fruity.config.ts file to configure your documentation site.

Configuration options are currently under development.

Usage

Once installed and running, you can start creating and viewing your documentation.

Author

Developed by WeeXnes

2.5 KiB Raw Blame History Unescape Escape