Technical Details

The Playbook is compiled from Markdown files using Jekyll. To propose a specific change, you can submit a pull request with your change to one of these source Markdown files. The Plays from the Playbook are available in the _plays folder.

You can also use Github's in-browser editing feature to make an edit to one of these Markdown files and submit your change for consideration without needing to install any additional software.

Running the Site Locally

To run the site locally on your own computer (most helpful for previewing your own changes), you will need to install Jekyll and other dependencies:

1. If you don't already have Ruby and Bundler installed, follow the first two steps in these Jekyll installation instructions.
2. Next, fork this repository and clone it on your computer.
3. Navigate to the folder on your computer, and run the command bundle install at the command line prompt.

To run the site locally, run jekyll serve --watch, then visit http://localhost:4000/ in your browser to preview the site.

Editing the Stylesheets

This project uses Sass for managing its style sheets. These styles are defined in the styles.scss file. We use Jekyll's native SASS support to auto-generate the required CSS when you run the site locally, as described above.

Détails Techniques

Le manuel est compilé à partir des fichiers Markdown en utilisant Jekyll. Pour proposer un changement, vous devez soumettre un Pull Request (https://help.github.com/articles/creating-a-pull-request "More Information on Submitting Pull Requests") avec votre changement dans l'un de ces fichiers Markdown source. Les stratégies techniques sont disponibles dans le dossier _plays.

Vous pouvez également utiliser la fonction d'édition dans le navigateur de Github pour modifier l'un de ces fichiers et soumettre vos changements.

Faire fonctionner le site localement

Pour faire fonctionner le site en local sur votre propre ordinateur (ce qui est très utile pour prévisualiser vos propres modifications), vous devrez installer Jekyll et d'autres dépendances:

1. Si vous n'avez pas encore installé Ruby et Bundler, suivez les deux premières étapes de ces instructions d'installation de Jekyll.
2. Ensuite, créez une bifurcation de ce dépôt et clonez-la sur votre ordinateur.
3. Naviguez vers le dossier sur votre ordinateur, et lancez la commande "Bundle install" à l'invite de la ligne de commande.

Pour faire fonctionner le site localement, executez jekyll serve --watch dans l'invite de la ligne de commande, puis visitez http://localhost:4000/ dans votre navigateur pour prévisionner le site.

Modifier les feuilles de style

Ce projet utilise Sass pour gérer ses feuilles de style. Ces styles sont définis dans le fichier styles.scss. Nous utilisons le support SASS natif de Jekyll pour générer automatiquement les feuilles de style CSS requises lorsque vous exécutez le site en local, comme décrit ci-dessus.