just the docs

Juste les documents

Un thème Jekyll moderne, hautement personnalisable et réactif pour la documentation avec recherche intégrée.
Facilement hébergé sur les pages GitHub avec peu de dépendances.

Voyez-le en action !

Une présentation vidéo pas à pas de diverses fonctionnalités Just the Docs

juste-les-documents-fonctionnalités-walkthrough.mp4

Installation

Utilisez le modèle

Le modèle Just the Docs constitue le moyen le plus simple, le plus rapide et le plus simple de créer un nouveau site Web utilisant le thème Just the Docs. Pour commencer à créer un site, cliquez simplement sur « utiliser le modèle » !

Remarque : Pour utiliser le thème, vous n'avez pas besoin de cloner ou de créer un fork sur le dépôt Just the Docs ! Vous ne devez le faire que si vous avez l'intention de parcourir les documents du thème localement, de contribuer au développement du thème ou de développer un nouveau thème basé sur Just the Docs.

Vous pouvez facilement configurer le site créé par le modèle pour qu'il soit publié sur les pages GitHub – le fichier README du modèle explique comment procéder, ainsi que d'autres détails.

Si Jekyll est installé sur votre ordinateur, vous pouvez également créer et prévisualiser le site créé localement . Cela vous permet de tester les modifications avant de les valider et d'éviter d'attendre les pages GitHub. ¹ Et vous pourrez déployer votre build local sur une plateforme différente de celle des pages GitHub.

Plus précisément, le site créé :

• utilise une approche basée sur les gemmes, c'est-à-dire utilise un Gemfile et charge la gemme just-the-docs
• utilise le workflow GitHub Pages/Actions pour créer et publier le site sur GitHub Pages

En dehors de cela, vous êtes libre de personnaliser les sites que vous créez avec le modèle, comme bon vous semble. Vous pouvez facilement modifier les versions de just-the-docs et de Jekyll qu'il utilise, ainsi qu'ajouter d'autres plugins.

Utiliser RubyGems

Alternativement, vous pouvez installer le thème en tant que Ruby Gem, sans créer de nouveau site.

Ajoutez cette ligne au Gemfile de votre site Jekyll :

 gem "just-the-docs"

Et ajoutez cette ligne au _config.yml de votre site Jekyll :

 theme : just-the-docs

Et puis exécutez :

 $ bundle

Ou installez-le vous-même en tant que :

 $ gem install just-the-docs

Alternativement, vous pouvez l'exécuter dans Docker lors du développement de votre site.

 $ docker-compose up

Usage

Consultez la documentation pour obtenir des informations sur l'utilisation.

Contribuer

Les rapports de bogues, les propositions de nouvelles fonctionnalités et les demandes d'extraction sont les bienvenus sur GitHub à l'adresse https://github.com/just-the-docs/just-the-docs. Ce projet est destiné à être un espace de collaboration sûr et accueillant, et les contributeurs doivent adhérer au code de conduite Contributor Covenant.

Soumission des modifications de code :

• Soumettez un problème qui motive les changements, en utilisant le modèle approprié
• Discutez des changements proposés avec les autres utilisateurs et les responsables
• Ouvrir une demande de tirage
• Assurez-vous que tous les tests CI réussissent
• Fournir des instructions pour vérifier l’effet des modifications
• Attendre la révision du code

Principes de conception et de développement de ce thème :

1. Le moins de dépendances possible
2. Aucun script de construction n'est nécessaire
3. Expérience mobile de première classe
4. Faites briller le contenu

Développement

Pour configurer votre environnement pour développer ce thème : forkez ce dépôt, puis exécutez l' bundle install à partir du répertoire racine.

Une configuration devcontainer moderne pour VSCode est incluse.

Votre thème est configuré comme un site Jekyll normal ! Pour tester votre thème, exécutez bundle exec jekyll serve et ouvrez votre navigateur à http://localhost:4000 . Cela démarre un serveur Jekyll utilisant votre thème. Ajoutez des pages, des documents, des données, etc. comme d'habitude pour tester le contenu de votre thème. Au fur et à mesure que vous apportez des modifications à votre thème et à votre contenu, votre site se régénérera et vous devriez voir les modifications dans le navigateur après une actualisation, comme d'habitude.

Lorsque ce thème sera publié, seuls les fichiers _layouts , _includes et _sass suivis avec Git seront inclus dans la gemme.

Licence

Le thème est disponible en open source selon les termes de la licence MIT.

Notes de bas de page

1. La publication des modifications apportées à votre site peut prendre jusqu'à 10 minutes après avoir transféré les modifications vers GitHub. ↩