Skip to content

Commit f47a8ca

Browse files
Evan LovelyEvanLovely
Evan Lovely
authored andcommitted
Adding docs on how to use Jekyll
1 parent 0df5439 commit f47a8ca

File tree

1 file changed

+39
-1
lines changed

1 file changed

+39
-1
lines changed

README.md

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,41 @@
11
# [Drupal Pattern Lab Website](http://drupal-pattern-lab.github.io)
22

3-
This is using GitHub pages; just push to publish.
3+
This is using [GitHub pages](https://pages.github.com); just push to publish.
4+
5+
To contribute, many pages can be simply added and edited using the GitHub UI - this is encouraged as it's quicker for many.
6+
7+
# Docs
8+
9+
- [Jekyll](https://jekyllrb.com/docs/home/)
10+
- [GitHub Pages](https://help.github.com/categories/customizing-github-pages/)
11+
- [Viewing Jekyll build error messages](https://help.github.com/articles/viewing-jekyll-build-error-messages/#viewing-jekyll-build-failure-messages-in-your-repository)
12+
13+
# Working Local
14+
15+
If one is working on the theming or any new features that needs double-checking on how Jekyll compiled it, it's encouraged to spin this up locally and test. It's easy!
16+
17+
## Requirements
18+
19+
- `bundle` - Ruby Dependency Manager (install with `gem install bundler` - may require `sudo`)
20+
21+
## Setup
22+
23+
```bash
24+
bundle install
25+
```
26+
27+
## Usage
28+
29+
Compile, serve, & watch:
30+
31+
```bash
32+
bundle exec jekyll serve
33+
```
34+
35+
Open <http://127.0.0.1:4000>
36+
37+
Other commands:
38+
39+
```bash
40+
bundle exec jekyll --help
41+
```

0 commit comments

Comments
 (0)