Skip to content

Commit eadd605

Browse files
author
hjonin
committed
First working version
1 parent 3912b48 commit eadd605

File tree

16 files changed

+6731
-0
lines changed

16 files changed

+6731
-0
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
/node_modules/
2+
/docs/

.idea/.gitignore

Lines changed: 5 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/codeStyles/codeStyleConfig.xml

Lines changed: 5 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/docsify-dsfr-template.iml

Lines changed: 9 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/misc.xml

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/modules.xml

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/vcs.xml

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.nojekyll

Whitespace-only changes.

LICENSE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2021-2023 DINUM/Etalab
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
Ce dépôt permet de générer un template de site de documentation basé sur le [DSFR](https://www.systeme-de-design.gouv.fr/) et [docsify](https://github.com/docsifyjs/docsify).
2+
3+
## Fonctionnalités
4+
5+
- Fonctionne via simple ajout de fichiers.
6+
- Configurable via les [options de docsify](https://docsify.js.org/#/configuration).
7+
8+
## Utilisation
9+
10+
- Télécharger le répertoire ([/docs](/docs)) contenant les fichiers du template.
11+
- Déposer les fichiers dans votre répertoire contenant la documentation, ou commencer votre documentation à partir de ce répertoire.
12+
13+
## Développement
14+
15+
- Cloner le dépôt :
16+
```
17+
git clone git@github.com:codegouvfr/docsify-dsfr-template.git
18+
```
19+
- Installer les dépendances :
20+
```
21+
npm install
22+
```
23+
- Construire le livrable dans [`/docs`](/docs) :
24+
```
25+
npm run build
26+
```
27+
- Lancer le serveur pour visualiser les modifications en temps réel (SCSS seulement) :
28+
```
29+
npm run serve-sass
30+
```

0 commit comments

Comments
 (0)