Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/etalab/doc.data.gouv.fr
Documentation du site data.gouv.fr.
https://github.com/etalab/doc.data.gouv.fr
documentation jekyll open-data static-site
Last synced: 28 days ago
JSON representation
Documentation du site data.gouv.fr.
- Host: GitHub
- URL: https://github.com/etalab/doc.data.gouv.fr
- Owner: etalab
- License: mit
- Created: 2017-11-28T12:43:25.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-11-13T13:58:49.000Z (about 1 year ago)
- Last Synced: 2024-06-11T17:24:11.337Z (7 months ago)
- Topics: documentation, jekyll, open-data, static-site
- Language: SCSS
- Homepage: https://doc.data.gouv.fr
- Size: 9.75 MB
- Stars: 7
- Watchers: 11
- Forks: 50
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Documentation de data.gouv.fr
Ce dépôt correspond au contenu du site [doc.data.gouv.fr](https://doc.data.gouv.fr), site consacré à la documentation de la plateforme [data.gouv.fr](https://data.gouv.fr).
## Contribuer
Les contributions sont les bienvenues. Elles peuvent prendre la forme de _pull requests_ effectuées [depuis un fork de ce dépôt](https://help.github.com/articles/fork-a-repo/), ou de discussions dans les [tickets GitHub du dépôt](https://github.com/etalab/doc.data.gouv.fr/issues).
## Démarrage rapide
### Ruby natif
Installer bundler :
```
gem install bundler
```
Compiler et démarrer un serveur de documentation :
```
git clone https://github.com/etalab/doc.data.gouv.fr
cd doc.data.gouv.fr
bundle install
bundle exec jekyll serve
```
La documentation apparaîtra alors à l’adresse suivante : http://localhost:4000.
### Docker Compose
Vous pouvez utiliser [docker-compose](https://docs.docker.com/compose/) pour tester vos modifications localement avant de les soumettre. Pour ce faire, il suffit simplement d’exécuter la commande :
```
docker-compose up
```
Ceci va télécharger l'image docker de [Jekyll](https://www.jekyll.io/) et installer les dépendances nécessaires avant d'effectuer le rendu du site. Le résultat sera disponible sur http://localhost:4000. Les modifications sont automatiquement prises en compte et provoquent un nouveau rendu du site.