La Documentation Technique simple avec CodeX Docs

Que ce soit pour un projet personnel ou une entreprise, la documentation est essentielle pour maintenir la clarté et l’efficacité du développement logiciel. Coder X Docs est là pour révolutionner cette tâche souvent fastidieuse en la rendant simple, efficace et surtout agréable.

Le But de CodeX Docs

CodeX Docs est un outil de documentation technique conçu pour faciliter la création, la gestion et la consultation de documentation techniques. Cet outil vise à simplifier le processus de documentation pour les développeurs, les équipes techniques et les gestionnaires de projets. Grâce à une interface intuitive et des fonctionnalités avancées, CodeX Docs permet de centraliser toutes les informations techniques en un seul endroit, garantissant ainsi une communication fluide et une meilleure collaboration au sein des équipes.

Pourquoi Choisir CodeX Docs ?

Interface Intuitive et Conviviale

L’outils se distingue par son interface utilisateur moderne et intuitive. Pas besoin d’être un expert pour commencer à l’utiliser – tout est pensé pour rendre l’expérience utilisateur la plus fluide possible.

Basé sur Editor.js

L’application est basé sur Editor.js, un éditeur de texte moderne qui permet de créer des documents structurés et bien formatés.

J’apprécie énormément le style épuré et minimaliste de l’application. Cela permet de se concentrer pleinement sur le contenu du document. C’est un vrai changement par rapport aux documents écrites sur Word ou sur des logiciels de Wiki.

Open Source

Un des principaux atouts de CodeX Docs est qu’il est open source (Oui la gratuité!). Il peut être utilisé aussi bien en interne au sein d’une entreprise que pour des projets personnels. Vu que l’outil est open source, il est possible de modifier le code source pour répondre à des besoins spécifiques et adapter l’outil à votre convenance.

Installation de CodeX Docs

Il est possible d’installer CodeX Docs de deux façons différentes :

• En utilisant le gestionnaire de paquets Yarn
• En utilisant Docker

Docker

Pour les plus pressés, voici comment l’installer facilement avec Docker. C’est parti !

1. Pré-requis : Assurez-vous que Docker est installé sur votre machine. Si ce n’est pas le cas, vous pouvez télécharger et installer Docker depuis le site officiel de Docker.
2. Créer le fichier docs-config.yaml pour la configuration de vos documents :

⚠️ Attention

Petite subtilité : si vous utilisez la nouvelle version de Docker, docker-compose est intégré directement dans Docker. Pour l’utiliser, vous devrez taper docker compose <CMD> au lieu de docker-compose <CMD>.

touch docs-config.yaml

Vous pouvez laisser ce fichier vide pour utiliser la configuration par défaut. Vous pouvez également remplacer certaines propriétés de configuration. Pour la documentation des propriétés de configuration, suivez cette page.

3. Créer le fichier docker-compose.yml

version: "3.2"
services:
  docs:
    image: ghcr.io/codex-team/codex.docs:v2
    ports:
      - 127.0.0.1:3000:3000
    environment:
      - APP_CONFIG_auth_password=codex
    volumes:
      - ./uploads:/usr/src/app/uploads
      - ./db:/usr/src/app/db
      - ./docs-config.yaml:/usr/src/app/docs-config.yaml

4. Lancer Docker Compose

docker-compose up

Yarn

1. Cloner le dépôt de CodeX Docs

git clone https://github.com/codex-team/codex.docs.git

2. Créez un fichier docs-config.local.yaml pour la configuration de vos documents :

touch docs-config.local.yaml

Vous pouvez laisser ce fichier vide pour utiliser la configuration par défaut. Vous pouvez également remplacer certaines propriétés de configuration. Pour la documentation des propriétés de configuration, suivez cette page.

3. Assurez-vous d’avoir Node.js (version 16 ou supérieure) et Yarn installés sur votre ordinateur. Ensuite, exécutez les commandes suivantes :

yarn install
yarn start

Conclusion

CodeX Docs se distingue par sa simplicité, l’installation est rapide et se fait en quelques lignes de commande. En quelques secondes, vous disposez d’un outil performant et facile à utiliser pour créer des documents techniques. Inutile de se compliquer la vie, concentrons-nous sur l’essentiel : le contenu.