دليل نمط بسيط للقضبان 5.1+ ، مصمم للسير بشكل جيد مع elemental_components. يستلهم الاثنان معا أعمال براد فروست والأفكار وراء دليل أسلوب Lonely Planet Rizzo.
أضف هذا السطر إلى 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 ، The Lonely Planet Guide. وكانت الإلهام الأخرى:
للحصول على قائمة من أدلة نمط العالم الحقيقي ، تحقق من http://styleguides.io.