Skip to content

Commit 21d6b9e

Browse files
author
mercedesb
committed
updated README with jekyll info
1 parent 157af37 commit 21d6b9e

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

Diff for: README.md

+33
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,38 @@
11
# writespeakcode.com
22

3+
### Getting started
4+
5+
This is a Jekyll site. Please find notes below for running the site.
6+
7+
Clone the repo
8+
```
9+
git clone https://github.com/WriteSpeakCode/writespeakcode.github.io.git
10+
```
11+
12+
Install the gems
13+
```
14+
bundle install
15+
```
16+
17+
Run the dev server
18+
```
19+
jekyll serve
20+
```
21+
22+
Build the production code
23+
```
24+
jekyll build
25+
```
26+
27+
28+
#### Dev server
29+
When running the dev server, you'll be able to make changes to the markup and styling, reload the page, and see your changes. While the dev server is running, it will update your built files with your new markup and styling. However, changes to data files or `_config.yml` require stopping and restarting the dev server.
30+
31+
#### Organization
32+
Each section on the site has it's own file within `_includes`. This allows for maximum reuse and minimal editing. They are then included within the various layouts or pages within the site.
33+
34+
We've started transitioning our previous css to small scss files that are imported in custom_2018.scss. Some of these new files have been completed converted to sass and use our site variables while others are still plain old css and could be made sass-y.
35+
336
## Contributing
437

538
We're in the middle of a re-write and this is our temporary site.

0 commit comments

Comments
 (0)