Skip to content

Latest commit

 

History

History
86 lines (53 loc) · 2.33 KB

README.md

File metadata and controls

86 lines (53 loc) · 2.33 KB

DOI

Documentation de Biblissima+

Ce site rassemble la documentation technique de l'infrastructure numérique de Biblissima+ (2021-2029), Observatoire des cultures écrites anciennes de l’argile à l’imprimé (ANR-21-ESRE-0005).

Il est créé et maintenu par l’équipe Portail Biblissima+.

Il s'appuie sur :

  • MkDocs, un générateur de site statique spécialisé pour de la documentation
  • Material for MkDocs, un thème complet pour MkDocs

Usage

Pré-requis

Installation

Récupérer le code source :

$ git clone https://gitlab.huma-num.fr/biblissima/doc.biblissima.git

Installer les dépendances :

$ cd doc.biblissima
$ pip install -r requirements.txt

Utilisation

Travailler sur le site en local :

// Lance un serveur local avec rafraîchissement automatique sur http://127.0.0.1:8000/
$ mkdocs serve

// Génère le site dans le répertoire "site/"
$ mkdocs build

// Affiche le message d'aide
$ mkdocs -h

Configuration

La configuration du projet est écrite en YAML dans mkdocs.yml.

Ce fichier contient notamment l'arborescence du menu de navigation dans la section nav.

Déploiement

Pour déployer le site sur le serveur de développement ou de production :

// cc-web-dev
$ ./deploy.sh dev

// cc-web
$ ./deploy.sh prod

Documentation

LICENCE

Sauf mention contraire, les contenus de ce site sont publiés sous Licence Ouverte / Open License 2.0.