component_library 0.0.4 → 0.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +42 -0
- data/lib/component_library/version.rb +1 -1
- metadata +10 -5
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 60e2785e6c63e005e6189c952017fef5a5988f8b
|
|
4
|
+
data.tar.gz: 107370624a36df202e474cf0c3c6ec361951a0a0
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 2354ca619669a0869992b7a254ba68283428327f09a0590b078e53f166a1f2bfb49ab2c3750f0489618f53f79451ad44216934952a77eb43c65eb6cd520fc859
|
|
7
|
+
data.tar.gz: ac8f14d8f1f8d67b5479741ec54839d31bc9659c0df20fb2e50603db237ce4743c29cda52ca50dcc99bff7465c527ff46b4013204bc5874ec80194f8309a6939
|
data/README.md
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# Component Library
|
|
2
|
+
|
|
3
|
+
Easily create your own HTML/CSS/JS component library.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
Add this line to your application's Gemfile:
|
|
8
|
+
|
|
9
|
+
gem 'component_library'
|
|
10
|
+
|
|
11
|
+
And then execute:
|
|
12
|
+
|
|
13
|
+
$ bundle
|
|
14
|
+
$ bundle exec rails generate component_library:install components
|
|
15
|
+
|
|
16
|
+
## Usage
|
|
17
|
+
|
|
18
|
+
* create a component inside (eg: `app/views/components/_icons.html.erb`)
|
|
19
|
+
* add markup to component
|
|
20
|
+
* visit /components in a browser
|
|
21
|
+
|
|
22
|
+
## Overrideable defaults
|
|
23
|
+
|
|
24
|
+
By default the component library will assume to use the application layout and CSS file (`application.html.erb` & `application.css`), in addition to some basic styles added by the gem itself. If you wish to override this feature and use a different stylesheet, change the root file path, or the url the library routes to, these can be configued inside an initializer.
|
|
25
|
+
|
|
26
|
+
```
|
|
27
|
+
ComponentLibrary.setup do |config|
|
|
28
|
+
config.application_css = "new_application_css"
|
|
29
|
+
config.root_path = "new_component_library"
|
|
30
|
+
config.root_directory = "new_view_directory"
|
|
31
|
+
end
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
If you want to use a totally different layout for your component library, simply create a new layout named `component_library.html.erb` in your layouts directory and change there as appropriate.
|
|
35
|
+
|
|
36
|
+
## Contributing
|
|
37
|
+
|
|
38
|
+
1. Fork it ( https://github.com/richarcher/component_library/fork )
|
|
39
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
|
40
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
|
41
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
|
42
|
+
5. Create new Pull Request
|
metadata
CHANGED
|
@@ -1,14 +1,15 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: component_library
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.0.
|
|
4
|
+
version: 0.0.5
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Rich Archer
|
|
8
|
+
- Grant Speelman
|
|
8
9
|
autorequire:
|
|
9
10
|
bindir: bin
|
|
10
11
|
cert_chain: []
|
|
11
|
-
date: 2016-04-
|
|
12
|
+
date: 2016-04-18 00:00:00.000000000 Z
|
|
12
13
|
dependencies:
|
|
13
14
|
- !ruby/object:Gem::Dependency
|
|
14
15
|
name: sqlite3
|
|
@@ -72,14 +73,16 @@ dependencies:
|
|
|
72
73
|
- - ">="
|
|
73
74
|
- !ruby/object:Gem::Version
|
|
74
75
|
version: 3.4.21
|
|
75
|
-
description:
|
|
76
|
+
description: Easily create your own HTML/CSS/JS component library
|
|
76
77
|
email:
|
|
77
|
-
- rich
|
|
78
|
+
- rich@richarcher.co.uk
|
|
79
|
+
- grantspeelman@gmail.com
|
|
78
80
|
executables: []
|
|
79
81
|
extensions: []
|
|
80
82
|
extra_rdoc_files: []
|
|
81
83
|
files:
|
|
82
84
|
- MIT-LICENSE
|
|
85
|
+
- README.md
|
|
83
86
|
- Rakefile
|
|
84
87
|
- app/assets/javascripts/_component_library/_prism.js
|
|
85
88
|
- app/assets/javascripts/_component_library/library.js
|
|
@@ -125,5 +128,7 @@ rubyforge_project:
|
|
|
125
128
|
rubygems_version: 2.4.5.1
|
|
126
129
|
signing_key:
|
|
127
130
|
specification_version: 4
|
|
128
|
-
summary:
|
|
131
|
+
summary: Create .erb partials of HTML markup to document your reusable CSS and JS
|
|
132
|
+
components for other developers; and create prototypes to see how they function
|
|
133
|
+
and look within your existing ecosystem.
|
|
129
134
|
test_files: []
|