Installation et création

L'interet est de construire un site web avec uniquement des fichiers en markdwon (moyennant d'autres plugin comme plantuml par exemple).

Prérequis

Installez NodeJS et npm sur votre Debian préférée.

apt update && apt -y install nodejs npm

Et comme ils sont pas capable de se decider sur comment récuperer des packages je vous conseille aussi d'installer Yarn

npm install --global yarn
# check de la version histoire de...
yarn --version

Installation

On va commencer a creer un dossier pour le projet et s'y placer.

mkdir monprojet
cd monprojet

Vous pouvez installer tout de zero mais je vais ici me baser sur create-vuepress-site (opens new window).

yarn create vuepress-site 

Vous pouvez répondre aux question ce qui generera un squelette pour le site.

Cela genere les fichiers/dossiers suivants:

.
|-- docs
    |-- package.json
    |-- src
        |-- config
        |   |-- README.md
        |-- guide
        |   |-- README.md
        |   |-- using-vue.md
        |-- index.md

On se place dans doc, recupere les dépendances et on lance le mode dev

cd docs
yarn install 

Maintenant en plus d'avoir DL des dépendances nécéssaires vous avez maintenant le dossier src/

|-- src
|   |-- config
|   |   -- README.md
|   |-- guide
|   |   |-- README.md
|   |   |-- using-vue.md
|   |-- index.md
|-- yarn.lock

Le mode "DEV"

En vous plaçant dans le repertoire monprojet/docs vous pouvez executer la commande suivante:

npm run dev

Cela va "compiler" votre projet et démarer un serveur web qui va vous permettre d'acceder a un rendu. Si vous laissez tourner ce mode dev et que vous modifiez des fichier, il recompilera tout seul. Pas besoin donc de redémarer systématiquement. Il y a même une gestion des versions intégré avec un git.

Le mode "Build"

npm run build

Cette commande permet de génerer un votre site dans sa version statique prete a mettre en production. Ce sera plus détaillé dans une autre page.

Vous trouverez le contenue dans le dossir monprojet/src/.vuepress/dist