Site internet du mutualab
HTML JavaScript CSS
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
contents
gulp
src
.gitignore
.travis.yml
_prose.yml
bower.json
contributors.md
gulpfile.js
licence.md
mutualab.sublime-project
package.json
readme.md

readme.md

Site internet du mutualab

Build Status

Site de l'espace de coworking mutualab

Modifier les contenus du site

Généralités

  • Pour modifier les contenus vous devez : avoir un compte github et soumettre une modification

Soumettre une modification

  • Cliquez sur le bouton Fork (en haut à droite)
  • Effectuez les corrections en vous connectant à prose.io avec votre compte github
  • Enregistrez vos corrections
  • Enfin, retournez dans github et cliquez sur new pull-request
  • Décrivez les modifications, si necessaire et cliquer sur create pull-request

Modifier les contenus sans utiliser prose

Les contenus modifiables du site se trouvent dans le dossier contents

Ce dossier est composé de :

  • fichiers .json qui permettent de modifier des configurations et les textes génériques de l'interface ( boutons, navigation etc.) Syntaxe Json.
  • fichiers .md qui permettent de modifier les contenus enrichis, à l'aide de la syntaxe Markdown (documentation)
  • un dossier pages qui contient des pages de contenu enrichi qui seront générées par le site.

Ajouter une image

Allez dans le dossier contents/images ajoutez le fichier (ou uploadez la sur github), vous pouvez ensuite vous servir de cette image dans un fichier .md le chemin relatif vers l'image commence par images/<nom-du-fichier-avec-son-extension>

À propos des pages générées automatiquement

Pour chaque fichier .md que vous créez dans le dossier contents/pages le moteur va générer une page nom-du-fichier-md.htmlvous pourrez alors l'utiliser comme lien dans un autre fichier .md. Les pages utilisent le système de configuration Front Matter pour définir les métadonnées de la page (titre de la page, description pour les moteurs de recherche etc.)

le modèle à respecter est le suivant :

---
title: Titre de la page
description: description pour les moteurs de recherche
nofollow: false ( optionnel )
---

title et description sont obligatoires, nofollow est optionnel

Utiliser un composant

Vous pouvez utiliser des composants dans les fichiers .md pour utiliser un composant vous devez employer la syntaxe suivante

[%components.<nom-du-composant>({"foo":"bar","lorem":"ipsum"})%]

Composants utilisables actuellement

components.pricingTable(configuration)

permet d'afficher le tableau des tarifs

[%components.pricingTable(<nom-du-fichier-de-configuration-du-tableau-sans-extension>)%]
components.callToAction({label,url})

permet d'afficher un gros bouton

[%components.callToAction({label:"<texte-du-bouton>",url:"<adresse-du-bouton>"%]

Contribuer

Pré-requis :

  • Nodejs
  • Bower
  • Gulp

Installer le projet en développement

  • Cloner le repo : git clone https://github.com/Mutualab/mutualab.org.git
  • Installer les dépendances du build tool de développement : npm install à executer à la racine du repo
  • Installer les dépendances du site bower install

Commandes Gulp

  • Tâche de développement : gulp watch
  • Pour générer le site : gulp build
  • Pour générer le projet en local et lancer le serveur de test : gulp build:serve
  • Vous pouvez ensuite envoyer une pull-request pour soumettre vos modification au mainteneur

Si vous voyez l'erreur suivante au stade de gulp watch, installez gulp en local npm install gulp :

[11:06:33] Local gulp not found in ~/github/jibundeyare/mutualab.org
[11:06:33] Try running: npm install gulp

Structure du projet

.
|-contents                ->  Contenus modifiables
|---images                ->  Image envoyée depuis prose.io
|---pages                 ->  Pages dynamiques
|-gulp                    ->  Taches Gulp
|-src                     ->  Sources du site
|---fonts                 ->  Typographies
|---images                ->  Images du site
|---ng                    ->  Logique cliente ( AngularJs )
|-----templates           ->  Templates client ( AngularJs )
|---render                ->  Pages serveur ( Nunjucks )
|-----components          ->  Composant utilisable dans les fichier `.md` ( Nunjucks )
|-----templates           ->  Templates des pages dynammiques ( Nunjucks )
|-----views               ->  Templates serveur ( Nunjucks )
|---sass                  ->  Styles de l'application ( Scss )
|-----components          ->  Styles des composants ( Scss )
|-----pages               ->  Styles des pages ( Scss )