generated from gllmAR/docsify-gabarit
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
53 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,37 @@ | ||
# Docsify | ||
|
||
|
||
[Docsify](https://docsify.js.org/#/) est un générateur de documentation en temps réel qui permet de créer des sites de documentation à partir de fichiers Markdown, sans avoir besoin de générer des fichiers HTML statiques à l'avance. Il est particulièrement utile pour des projets open-source, des manuels techniques, et des guides utilisateurs. Docsify se distingue par sa simplicité et sa capacité à fonctionner directement depuis le navigateur sans compilation préalable. | ||
|
||
## Caractéristiques principales | ||
|
||
### Documentation basée sur Markdown : | ||
|
||
Docsify utilise des fichiers Markdown (fichiers .md) pour structurer et écrire le contenu de la documentation. Cela permet aux utilisateurs de se concentrer sur l’écriture du contenu sans se soucier de la structure HTML. | ||
|
||
### Pas de génération statique : | ||
|
||
Contrairement à d'autres générateurs de sites statiques comme Jekyll ou Hugo, Docsify ne nécessite pas de précompilation des fichiers. Vous ajoutez simplement vos fichiers Markdown, et Docsify se charge du rendu directement dans le navigateur. | ||
|
||
### Facilité d'installation : | ||
|
||
Docsify peut être installé localement via npm (Node Package Manager), ou bien utilisé via un simple CDN sans aucune installation locale. | ||
Par exemple, avec une inclusion CDN, il suffit de créer un fichier index.html avec un lien vers la bibliothèque Docsify pour démarrer. | ||
|
||
### Personnalisation flexible : | ||
|
||
Vous pouvez personnaliser le thème de Docsify, ajouter des barres latérales (sidebars), un menu de navigation, des ancres pour les titres, et plus encore. | ||
Il permet aussi d'ajouter des plugins ou des extensions pour des fonctionnalités supplémentaires comme la génération de PDF, l'intégration de vidéos, ou des fonctionnalités interactives. | ||
|
||
|
||
### Support de recherche : | ||
|
||
Docsify intègre une fonctionnalité de recherche rapide qui indexe les titres et sous-titres des documents, facilitant ainsi la navigation. | ||
|
||
### Support pour les Pages GitHub : | ||
|
||
Docsify fonctionne très bien avec Pages GitHub, permettant d’héberger la documentation directement sur GitHub. Il est ainsi facile de maintenir la documentation en lien avec un projet et de la rendre accessible à tous via une URL publique. | ||
|
||
### Awesome Docsify | ||
|
||
* [https://docsify.js.org/#/awesome](https://docsify.js.org/#/awesome) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters