elemental_styleguide
1.0.0
Guide de style simple pour Rails 5.1+, conçu pour bien aller avec Elemental_Components. Les deux ensemble sont inspirés par les œuvres de Brad Frost et par les pensées derrière le guide de style de Lonely Planet Rizzo.
Ajoutez cette ligne à Gemfile de votre application:
gem "elemental_styleguide"Puis exécuter:
$ bundleExécutez le générateur d'installation:
$ bin/rails g elemental_styleguide:installCela créera les fichiers et répertoires suivants:
app/
views/
layouts/
styleguide/
example.html.erb
styleguide/
01_home.md
Le guide de style peut être monté dans votre fichier de routes avec:
mount ElementalStyleguide :: Engine => "/styleguide" Vous pouvez désormais accéder au guide de style à http://localhost:3000/styleguide .
Vous pouvez créer des pages de guidage de style simplement en ajoutant des fichiers Markdown au répertoire app/views/styleguide . Ceux-ci peuvent être structurés en les mettant en sous-répertoires et triés en préfixant les noms de fichiers avec un chiffre.
Consultez l'inspiration du guide de style de Brad Frost pour l'inspiration du guide de style.
Une syntaxe spéciale Markdown, inspirée du catalogue, peut être utilisée pour rendre des exemples de tout code erb sur la page Guide de style, dans le contexte de votre propre application:
# Example
``` example
<%= "Hello world" %>
```Il est possible de transmettre des options à l'exemple, afin de contrôler la largeur et la hauteur de l'élément d'emballage:
``` example
width: 500
height: 200
---
<%= "Hello world" %>
``` Les exemples ont besoin de CSS et JS de votre application afin de fonctionner correctement. Il existe un fichier de mise en page app/views/layouts/styleguide/example.html.erb dans lequel des exemples sont rendus. Ce fichier peut être modifié afin d'ajouter des balises supplémentaires à l'en-tête, comme le javascript_pack_tag lors de l'utilisation du gemme WebPacker, ou des classes et des styles sur la balise corporelle.
Cette bibliothèque, avec Elemental_Components, a été inspirée par les écrits de Brad Frost sur les guides de conception et de style de vie atomiques, et Rizzo, le guide de style Lonely Planet. Les autres inspirations étaient:
Pour une liste de guides de style réel, consultez http://styleguides.io.
