/documentation

Internal documentation for ARES users

Primary LanguageCSS

ARES documentation repository

Contribuer à la documentation

Mise en place environnement

  • Avoir une installation de ruby

    sudo apt-get install ruby1.9.3 rubygems
  • Installer bundler

    sudo gem install bundler
  • Installer les dépendances du projet

    bundle install
  • Lancer le server

    bundle exec middleman server
  • Vous pouvez maintenant modifier les fichier de la documentation et consulter vos changement à l'adresse http://localhost:4567

Coloration syntaxique

Il est possible d'avoir de la coloration syntaxique markdown avec

```ruby
puts "toto"
```
puts "toto"

pour le laguage ruby par exemple

Déployer

Pour déployer les mises à jour, il faut build le projet puis pusher le contenu du dossier build sur la branch gh-pages

bundle exec middleman build && bundle exec middleman deploy