diff --git a/README.md b/README.md index 8607e02..bf9a11a 100755 --- a/README.md +++ b/README.md @@ -1,57 +1,41 @@ -# Docus Starter +

+ -Starter template for [Docus](https://docus.dev). -## Clone +[![docs.djeex.fr](https://img.shields.io/badge/DjeexLab-00b0f0?style=for-the-badge&logoColor=white&logo=materialformkdocs)](https://docs.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://docs.djeex.fr/) -Clone the repository (using `nuxi`): +

+# 🔧 De la doc, encore de la doc +**Djeex Lab** c'est avant tout un projet personnel visant à héberger chez soi le plus de services possibles du quotidien sans passer par des plateformes propriétaires (Google, Apple, Netflix...). Cette doc utilise [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) -```bash -npx nuxi init -t themes/docus -``` +Ce repo contient de quoi modifier les pages, ajouter vos changements, et redéployer le site. ## Setup -Install dependencies: +Installer les dépendances ```bash -yarn install +npm install ``` -## Development +## Environnement de dévelopment (port 3000) ```bash -yarn dev +npm run dev ``` -## Edge Side Rendering - -Can be deployed to Vercel Functions, Netlify Functions, AWS, and most Node-compatible environments. - -Look at all the available presets [here](https://v3.nuxtjs.org/guide/deploy/presets). +## Génération des pages statiques ```bash -yarn build +npm run generate ``` -## Static Generation - -Use the `generate` command to build your application. - -The HTML files will be generated in the .output/public directory and ready to be deployed to any static compatible hosting. - -```bash -yarn generate -``` +Les fichiers HTML seront générés dans le dossier .output/public et prêts à être déployés sur n'importe quel hébergement compatible avec un site statique. ## Preview build -You might want to preview the result of your build locally, to do so, run the following command: +Si vous voulez voir immédiatement le résultat de la génération du site vous pouvez lancer un serveur de preview : ```bash -yarn preview -``` - ---- - -For a detailed explanation of how things work, check out [Docus](https://docus.dev). +npm run preview +``` \ No newline at end of file