elemental_styleguide

Руководство по стилю элементарного стиля

Простой руководство по стилю для Rails 5.1+, предназначенное для хорошего успеха с elemental_components. Два вместе вдохновлены работами Брэда Фроста и мыслями, стоящим за руководством по стилю одинокой планеты Риццо.

Установка

Добавьте эту строку в Gemfile вашего приложения:

 gem "elemental_styleguide"

А затем выполнить:

$ bundle

Запустите генератор установки:

$ bin/rails g elemental_styleguide:install

Это создаст следующие файлы и каталоги:

 app/
  views/
    layouts/
      styleguide/
        example.html.erb
    styleguide/
      01_home.md

Руководство по стилю может быть установлено в вашем файле маршрутов с:

 mount ElementalStyleguide :: Engine => "/styleguide"

Теперь вы можете получить доступ к руководству по стилю по адресу http://localhost:3000/styleguide .

Страницы

Вы можете создавать страницы руководства по стилю, просто добавив файлы Markdown в каталог app/views/styleguide . Они могут быть структурированы, поместив их в подкатарии и отсортированы путем префикса имен файлов с помощью цифры.

Проверьте руководство по стилю стиля Брэда Фроста для вдохновения в стиле.

Примеры

Специальный синтаксис отметки, вдохновленный каталогом, может использоваться для отображения примеров любого кода erb на странице руководства по стилю, в контексте вашего собственного приложения:

 # Example

``` example
<%= "Hello world" %>
```

Можно передать параметры на пример, чтобы контролировать ширину и высоту элемента обертки:

 ``` example
width: 500
height: 200
---
<%= "Hello world" %>
```

Примеры нуждаются в CSS и JS вашего приложения, чтобы правильно функционировать. Существует app/views/layouts/styleguide/example.html.erb файл макета, который примеры отображаются внутри. Этот файл может быть изменен, чтобы добавить дополнительные теги в заголовок, например javascript_pack_tag при использовании драгоценного камня Webpacker или классов и стилей для тега тела.

Благодарности

Эта библиотека, вместе с elemental_components, была вдохновлена писаниями Брэда Фроста на руководствах по атомному дизайну и стилю жизни, а также Rizzo, руководством по стилю Lonely Planet. Другими вдохновениями были:

• Каталог - руководство по стилю для React
• Справочник - Руководство по стилю React
• React styleguidist - руководство по стилю для React
• Ячейки - Просмотреть компоненты для Ruby
• Komponent - Просмотреть компоненты для Ruby

Чтобы получить список руководств по реальному мировому стилю, ознакомьтесь с http://styleguides.io.