Documentation numérique professionnelle

Utilisez un Wiki comme intranet ou extranet et partagez votre documentation d'entreprise.

(Ref: Kapsule 7)

Copie d'écran de la Kapsule 7

Présentation

  • Wikijs est un Wiki moderne qui permet de créer et de modifier de façon collaborative et simple des pages web. C'est un gestionnaire de contenu efficace et de premier choix pour toutes les équipes et les entreprises qui souhaitent disposer d'un environnement web (interne ou externe) pour partager des bases de connaissances, communiquer des procédures, des informations internes et autres.
  • Wikijs permet la gestion native du format Markdown, simplifiant ainsi la mise en page.
  • Wikijs offre également l'ajout de différents modules complémentaires en fonction de vos besoins spécifiques.
  • Wikijs est également compatible avec les principaux fournisseurs d'authentification.
  • Vous pouvez directement tester Wikijs en ligne à l'adresse suivante.

Compétences techniques requises

Environnement nécessaire

Pour fonctionner, Wikijs nécessite un hébergement composé :

  1. d'un environnement serveur suffisamment performant (CPU 2 cores minimum, 1GB de RAM minimum, d'un espace disque dédié d'au minimum 1GB).
  2. D’une base de données de type PostgreSQL (recommandé pour de meilleures performances), MySQL 8.0 ou plus, MariaDB 10.2.7 ou plus, MS SQL Server 2012 ou plus, SQLite 3.9 ou plus.
  3. De Node.js 10.12 ou plus.
  4. D'un certificat SSL pour les connexions sécurisées.

Cet environnement peut être installé par vos soins sur votre propre matériel (Linux, Mac, Windows) ou directement loué chez un hébergeur.

Depuis la documentation officielle, vous serez renseigné(e) sur les configurations requises.

Vous pouvez également nous contacter pour plus d’informations.

Installation

  1. Depuis votre console, téléchargez Wikijs avec :
wget https://github.com/Requarks/wiki/releases/download/2.5.201/wiki-js.tar.gz
  1. Créez un nouveau dossier pour votre projet et faite l'extraction dans ce dossier:
mkdir wiki
tar xzf wiki-js.tar.gz -C ./wiki
cd ./wiki
  1. Dupliquez le fichier de configuration:
cp config.sample.yml config.yml
  1. Ouvrez le fichier de configuration pour l'éditer : nano config.yml

  2. Consultez cette documentation officielle pour configurer votre config.yaml en fonction de l'environnement que vous avez mis en place.

  3. Lancez votre wiki avec

node server
  1. Si tout c'est bien passé et que les coeurs sont apparus dans votre console, alors vous pouvez ouvrir votre navigateur web et vous connecter à l'adresse de votre wiki pour terminer l'installation.

Utilisation de Wikijs

  • Lors de votre première connexion à Wikijs, vous débutez par la création de votre "Home page", avec trois types de pages par défaut:
    • Code : Construire vos pages directement en HTML.
    • Markdown : Utiliser le format Markdown pour mettre en style vos pages (recommandé).
    • Visual Editor : Utiliser le WYSIWYG pour mettre en style vos pages comme un éditeur de texte traditionnel (déconseillé si vous souhaitez utiliser des diagrammes de type PlantUML).
  • Depuis les paramètres de votre wiki, vous pouvez personnaliser en profondeur votre nouveau wiki.

Pour plus d'informations et découvrir toutes les fonctionnalités de votre nouveau wiki, vous pouvez consulter la documentation complète officielle.

Informations importantes