Skip to content

Commit dcd0339

Browse files
committed
Add Gemfile and update docs
1 parent 3d67bc4 commit dcd0339

File tree

4 files changed

+162
-50
lines changed

4 files changed

+162
-50
lines changed

Gemfile

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
source 'https://rubygems.org'
2+
3+
require 'json'
4+
require 'open-uri'
5+
versions = JSON.parse(open('https://pages.github.com/versions.json').read)
6+
7+
gem 'github-pages', versions['github-pages']
8+
9+
gem 'jekyll'
10+
gem 'rouge'
11+
gem 'sass'

Gemfile.lock

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
RedCloth (4.2.9)
5+
activesupport (4.2.4)
6+
i18n (~> 0.7)
7+
json (~> 1.7, >= 1.7.7)
8+
minitest (~> 5.1)
9+
thread_safe (~> 0.3, >= 0.3.4)
10+
tzinfo (~> 1.1)
11+
addressable (2.3.8)
12+
blankslate (2.1.2.4)
13+
classifier-reborn (2.0.3)
14+
fast-stemmer (~> 1.0)
15+
coffee-script (2.4.1)
16+
coffee-script-source
17+
execjs
18+
coffee-script-source (1.9.1.1)
19+
colorator (0.1)
20+
ethon (0.8.0)
21+
ffi (>= 1.3.0)
22+
execjs (2.6.0)
23+
fast-stemmer (1.0.2)
24+
ffi (1.9.10)
25+
gemoji (2.1.0)
26+
github-pages (39)
27+
RedCloth (= 4.2.9)
28+
github-pages-health-check (~> 0.2)
29+
jekyll (= 2.4.0)
30+
jekyll-coffeescript (= 1.0.1)
31+
jekyll-feed (= 0.3.1)
32+
jekyll-mentions (= 0.2.1)
33+
jekyll-redirect-from (= 0.8.0)
34+
jekyll-sass-converter (= 1.3.0)
35+
jekyll-sitemap (= 0.8.1)
36+
jemoji (= 0.5.0)
37+
kramdown (= 1.5.0)
38+
liquid (= 2.6.2)
39+
maruku (= 0.7.0)
40+
mercenary (~> 0.3)
41+
pygments.rb (= 0.6.3)
42+
rdiscount (= 2.1.7)
43+
redcarpet (= 3.3.2)
44+
terminal-table (~> 1.4)
45+
github-pages-health-check (0.5.3)
46+
addressable (~> 2.3)
47+
net-dns (~> 0.8)
48+
public_suffix (~> 1.4)
49+
typhoeus (~> 0.7)
50+
html-pipeline (1.9.0)
51+
activesupport (>= 2)
52+
nokogiri (~> 1.4)
53+
i18n (0.7.0)
54+
jekyll (2.4.0)
55+
classifier-reborn (~> 2.0)
56+
colorator (~> 0.1)
57+
jekyll-coffeescript (~> 1.0)
58+
jekyll-gist (~> 1.0)
59+
jekyll-paginate (~> 1.0)
60+
jekyll-sass-converter (~> 1.0)
61+
jekyll-watch (~> 1.1)
62+
kramdown (~> 1.3)
63+
liquid (~> 2.6.1)
64+
mercenary (~> 0.3.3)
65+
pygments.rb (~> 0.6.0)
66+
redcarpet (~> 3.1)
67+
safe_yaml (~> 1.0)
68+
toml (~> 0.1.0)
69+
jekyll-coffeescript (1.0.1)
70+
coffee-script (~> 2.2)
71+
jekyll-feed (0.3.1)
72+
jekyll-gist (1.3.4)
73+
jekyll-mentions (0.2.1)
74+
html-pipeline (~> 1.9.0)
75+
jekyll (~> 2.0)
76+
jekyll-paginate (1.1.0)
77+
jekyll-redirect-from (0.8.0)
78+
jekyll (>= 2.0)
79+
jekyll-sass-converter (1.3.0)
80+
sass (~> 3.2)
81+
jekyll-sitemap (0.8.1)
82+
jekyll-watch (1.3.0)
83+
listen (~> 3.0)
84+
jemoji (0.5.0)
85+
gemoji (~> 2.0)
86+
html-pipeline (~> 1.9)
87+
jekyll (>= 2.0)
88+
json (1.8.3)
89+
kramdown (1.5.0)
90+
liquid (2.6.2)
91+
listen (3.0.3)
92+
rb-fsevent (>= 0.9.3)
93+
rb-inotify (>= 0.9)
94+
maruku (0.7.0)
95+
mercenary (0.3.5)
96+
mini_portile (0.6.2)
97+
minitest (5.8.1)
98+
net-dns (0.8.0)
99+
nokogiri (1.6.6.2)
100+
mini_portile (~> 0.6.0)
101+
parslet (1.5.0)
102+
blankslate (~> 2.0)
103+
posix-spawn (0.3.11)
104+
public_suffix (1.5.1)
105+
pygments.rb (0.6.3)
106+
posix-spawn (~> 0.3.6)
107+
yajl-ruby (~> 1.2.0)
108+
rb-fsevent (0.9.6)
109+
rb-inotify (0.9.5)
110+
ffi (>= 0.5.0)
111+
rdiscount (2.1.7)
112+
redcarpet (3.3.2)
113+
rouge (1.10.1)
114+
safe_yaml (1.0.4)
115+
sass (3.4.18)
116+
terminal-table (1.5.2)
117+
thread_safe (0.3.5)
118+
toml (0.1.2)
119+
parslet (~> 1.5.0)
120+
typhoeus (0.8.0)
121+
ethon (>= 0.8.0)
122+
tzinfo (1.2.2)
123+
thread_safe (~> 0.1)
124+
yajl-ruby (1.2.1)
125+
126+
PLATFORMS
127+
ruby
128+
129+
DEPENDENCIES
130+
github-pages (= 39)
131+
jekyll
132+
json
133+
rouge
134+
sass
135+
136+
BUNDLED WITH
137+
1.10.5

README.md

Lines changed: 14 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Primer
1+
# Origin
22

33
Primer is the CSS toolkit that powers GitHub's front-end design. It's purposefully limited to common components to provide our developers with the most flexibility, and to keep GitHub uniquely *GitHubby*. It's built with SCSS and available via Bower, so it's easy to include all or part of it within your own project.
44

@@ -22,70 +22,35 @@ _**Heads up!** We love open source, but Primer is unlikely to add new features t
2222

2323
## Install
2424

25-
### Manually
26-
27-
Download the [latest release](https://github.com/primer/primer/releases/latest) and copy the SCSS files over to your own project. Once your files are in place, jump to the [usage guidelines](#usage) for including Primer into your own CSS.
28-
29-
### Bower
25+
Prerequisites:[Node.js and npm](http://nodejs.org/download/)
3026

3127
```
32-
$ bower install primer-css --save
33-
```
34-
35-
### Things to know
36-
37-
**Hey, GitHubbers!** For GitHub.com, you'll need to `cd` into `vendor/assets` and run `bower install` there. Be sure to commit and push all the changes, including the `bower.json` and everything under `bower_components`.
38-
39-
## Usage
40-
41-
Once included, simply `@import` either the master SCSS file, or the individual files as you need them.
42-
43-
```scss
44-
// Example: All of Primer
45-
@import "primer-css/scss/primer";
46-
47-
// Example: Individual files
48-
@import "primer-css/scss/variables";
49-
@import "primer-css/scss/mixins";
50-
@import "primer-css/scss/base";
51-
```
52-
53-
## Documentation
54-
55-
Primer's documentation is built with Jekyll and published to `http://primercss.io` via the `gh-pages` branch.
56-
57-
### Dependencies
58-
59-
You'll need the following installed:
60-
61-
- Latest Jekyll (minimum v2.2.0): `$ gem install jekyll`
62-
- Latest Rouge: `$ gem install rouge`
63-
- Latest Sass: `$ gem install sass`
64-
- Latest Grunt CLI: `$ npm install -g grunt-cli`
65-
- [Node.js and npm](http://nodejs.org/download/)
66-
67-
Chances are you have all this already if you work on `github/github` or similar projects. If you have all those set up, now you can install the dependencies:
68-
69-
```bash
70-
$ npm install
71-
$ bower install
28+
git clone --depth 1 --origin source git@github.com:fac/fa-origin.git new-project-folder
29+
bundle install
30+
npm install
31+
npm install -g grunt-cli
32+
bower install
7233
```
7334

74-
### Running locally
35+
### Run locally
7536

7637
From the Terminal, start a local Jekyll server:
7738

7839
```bash
7940
$ jekyll serve
8041
```
8142

82-
Open a second Terminal tab to automatically recompile the Sass files, run autoprefixer, and update our [Primer stats file](#primer-stats):
43+
Open a second Terminal tab to automatically update our [Primer stats file](#primer-stats):
8344

8445
```bash
8546
$ grunt watch
8647
```
8748

88-
Alternatively, you can manually run `grunt` and `jekyll serve` when needed.
49+
50+
## Documentation
51+
52+
Primer's documentation is built with Jekyll and published to `http://primercss.io` via the `gh-pages` branch.
53+
8954

9055
### Publishing
9156

docs/assets/scss/components-temp/_button.scss

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ button:focus {
2020
border-color: rgba(0,0,0,0.08) rgba(0,0,0,0.15) rgba(0,0,0,0.28) rgba(0,0,0,0.15);
2121
cursor: pointer;
2222
display: inline-block;
23-
letter-spacing: -0.02em;
2423
text-align: center;
2524
@include border-radius(default);
2625
@include box-shadow(0, 1px, 0, rgba(0,0,0,0.05));

0 commit comments

Comments
 (0)