Skip to content
Les guides d'Etalab : bonnes pratiques relatives aux données, algorithmes et codes sources
JavaScript Vue CSS
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
.github Update CODEOWNERS file (#45) Jan 2, 2020
.vuepress Hide sidebar links on mobile (#50) Jan 14, 2020
algorithmes Update 0-guide.md Jan 13, 2020
data.gouv.fr
juridique Update README.md Jan 13, 2020
logiciels Sidebar titles (#44) Jan 7, 2020
qualite Update 1-preparer-le-jeu-de-donnees.md Jan 13, 2020
.gitignore ajout images Oct 16, 2019
.nvmrc Add vuepress (#1) Oct 7, 2019
LICENSE.md Introduce a README #5 Oct 8, 2019
README.md Yarn to npm in README Oct 21, 2019
accueil.md Update accueil.md Jan 13, 2020
index.md
now.json Add vuepress (#1) Oct 7, 2019
package-lock.json Sidebar titles (#44) Jan 7, 2020
package.json

README.md

Guides d'Etalab

Ce dépôt contient plusieurs guides rédigés par Etalab ainsi que le code utilisé pour fournir un site web présentant ces guides.

Ajouter un guide

Pour ajouter un guide, il suffit d'ajouter un répertoire à la racine du dépôt. Ce répertoire doit contenir un fichier README.md. Le titre de ce fichier définit le titre du guide.

Pour ajouter des chapitres au guide, il suffit d'ajouter des fichiers .md dans le répertoire précédemment créé, par exemple 0-introduction.md. Les titres de ces fichiers définissent les titres des chapitres.

Les chapitres apparaissent par ordre alphabétique dans les menus de navigation. Il est donc conseillé de préfixer le nom de fichier de chaque chapitre par son numéro, par exemple 0-introduction.md, 1-chapitre-1.md...

La page d'accueil et les menus de navigation sont générés automatiquement.

Il est recommandé d'utiliser un permalink dans chaque fichier de chapitre afin d'obtenir des URLs propres et stables même en cas de re-numérotation de chapitres, par exemple pour qualite/1-preparer-le-jeu-de-donnees.md :

---
permalink: /qualite/preparer-le-jeu-de-donnees
---

Par convention, les images des guides sont stockées dans un répertoire images dans le répertoire de chaque guide.

Développement local

Dans la majorité des cas, l'utilisation de GitHub par le biais de son interface web vous suffira. Vous pouvez directement éditer le contenu des guides par le biais de pull-requests et profiter d'une prévisualisation ensuite.

Si nécessaire, voici comment faire tourner ce projet localement :

npm install
npm run dev
open http://localhost:8080

Licence

Le contenu de ce dépôt est publié sous une double licence.

2019 DINSIC, Etalab.

You can’t perform that action at this time.