Download elemental_styleguide - Download Kode Sumber elemental

elemental_styleguide

Komponen pihak ketiga

1.0.0

Unduh

Panduan Gaya Elemental

Panduan Gaya Sederhana untuk Rails 5.1+, dirancang untuk cocok dengan elemental_components. Keduanya bersama -sama terinspirasi oleh karya -karya Brad Frost dan oleh pemikiran di balik pemandu gaya Lonely Planet Rizzo.

Instalasi

Tambahkan baris ini ke gemfile aplikasi Anda:

 gem "elemental_styleguide"

Dan kemudian mengeksekusi:

$ bundle

Jalankan Install Generator:

$ bin/rails g elemental_styleguide:install

Ini akan membuat file dan direktori berikut:

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

Panduan gaya dapat dipasang di file rute Anda dengan:

 mount ElementalStyleguide :: Engine => "/styleguide"

Anda sekarang dapat mengakses panduan gaya di http://localhost:3000/styleguide .

Halaman

Anda dapat membuat halaman panduan gaya hanya dengan menambahkan file markdown ke direktori app/views/styleguide . Ini dapat disusun dengan meletakkannya di subdirektori, dan diurutkan dengan mengawali nama file dengan digit.

Lihat Panduan Panduan Gaya Brad Frost untuk Inspirasi Panduan Gaya.

Contoh

Sintaks penurunan harga khusus, terinspirasi oleh katalog, dapat digunakan untuk memberikan contoh kode erb apa pun pada halaman Panduan Gaya, dalam konteks aplikasi Anda sendiri:

 # Example

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

Dimungkinkan untuk meneruskan opsi ke contoh, untuk mengontrol lebar dan tinggi elemen pembungkus:

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

Contoh membutuhkan CSS dan JS aplikasi Anda agar berfungsi dengan baik. Ada app/views/layouts/styleguide/example.html.erb . File ini dapat dimodifikasi untuk menambahkan tag tambahan ke header, seperti javascript_pack_tag saat menggunakan permata webpacker, atau kelas dan gaya ke tag tubuh.

Ucapan Terima Kasih

Perpustakaan ini, bersama dengan elemental_components, terinspirasi oleh tulisan -tulisan Brad Frost pada desain atom dan pemandu gaya hidup, dan Rizzo, panduan gaya Lonely Planet. Inspirasi lainnya adalah: