VuePress thème Gouv Fr

Un thème VuePress qui s'inspire de template.data.gouv.fr et hérite du thème par défaut de VuePress.

Démonstration

https://guides.etalab.studio utilise ce thème. Vous pouvez consulter le code source associé.

Installation

Ajoutez le thème en tant que dépendance dans votre fichier package.json :

npm install vuepress-theme-gouv-fr

Indiquez que vous utilisez ce thème dans votre fichier de configuration VuePress (probablement à l'emplacement .vuepress/config.js)

module.exports = {
  // D'autres éléments de configuration
  theme: 'vuepress-theme-gouv-fr'
}

Pour plus de détails, reportez-vous à la documentation de VuePress.

Configuration

Titres de sections

Lorsque votre documentation comporte plusieurs dossiers, il est possible de faire apparaitre un titre de section lorsque vous vous trouvez dans un dossier.

Dans votre fichier de configuration VuePress (probablement .vuepress/config.js), ajoutez ceci :

module.exports = {
  themeConfig: {
    sidebarTitles: {
        '/qualite/': "Préparer les données",
        '/juridique/': "Identifier les données à ouvrir",
    }
  }
}

Composants

Les composants suivants sont disponibles. Ils sont tous indépendants les uns des autres et leur utilisation est optionnelle.

Génération automatique du menu

VuePress vous laisse la possibilité de définir vous-même votre menu, en précisant les différents groupes, les pages contenues et leur ordre.

Si vous souhaitez afficher tous les dossiers de votre répertoire et tous les fichiers Markdown contenus dans ces dossiers (dans un ordre alphabétique), vous pouvez générer le menu automatiquement. Pour contrôler l'ordre des pages, vous pouvez préfixer vos pages par un numéro, par exemple 1_introduction.md, 2_installation.md.

Dans votre fichier de configuration VuePress (probablement .vuepress/config.js), ajoutez ceci :

const { getSidebar } = require('vuepress-theme-gouv-fr/sidebar.js')

module.exports = {
  // D'autres éléments de configuration
  themeConfig: {
    sidebar: getSidebar(),
  }
}

CurrentGroupToc

Permet d'afficher dans la barre de navigation uniquement les éléments du groupe courant lorsque vous utilisez plusieurs groupes au sein de votre documentation.

Il s'utilise de la manière suivante, probablement dans un fichier README.md :

# Super guide

Une description

<CurrentGroupToc></CurrentGroupToc>

Versions supportées

Ce thème est disponible pour les versions 0 et 1 de VuePress.

Les versions en 0.* de ce thème sont compatibles avec VuePress 0, tandis que les versions en 1.* sont compatibles avec VuePress 1.

Licence

MIT