docudjeex/README.md
2025-06-04 15:04:16 +00:00

45 lines
1.3 KiB
Markdown
Executable File

<p align="center">
<img src="https://git.djeex.fr/Djeex/DjeexLab/raw/branch/main/docs/files/img/global/lab.svg" align="center" width="700">
[![docu.djeex.fr](https://img.shields.io/badge/Docu·djeex-00b0f0?style=for-the-badge&logoColor=white&logo=materialformkdocs)](https://docu.djeex.fr/)
[![](https://dcbadge.limes.pink/api/server/jvhardware)](https://discord.gg/jvhardware)
[![Uptime-Kuma](https://stats.djeex.fr/api/badge/23/status?style=for-the-badge)](https://docu.djeex.fr/)
</p>
# 🔧 Docs, More Docs
**Docu·djeex** is first and foremost a personal project aimed at self-hosting as many everyday services as possible — without relying on proprietary platforms (Google, Apple, Netflix, etc.).
This documentation site is built using [Nuxt.js](https://nuxt.com/).
This repository contains everything you need to edit pages, apply your changes, and redeploy the site.
## Setup
Install dependencies:
```bash
npm install
```
## Development Environment (port 3000)
```bash
npm run dev
```
## Generate Static Pages
```bash
npm run generate
```
The HTML files will be generated in the `.output/public` folder and are ready to be deployed on any static-compatible hosting.
## Preview Build
If you'd like to immediately see the result of your static site build, you can launch a preview server:
```bash
npm run preview
```