OCram85/beautifulSA-jekyll
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

changes to readme

Browse Source
This commit is contained in:
Dean Attali 2015-03-03 00:36:56 -08:00
parent 86e9e1e6f9
commit 39246396a3
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -27,7 +27,7 @@ Edit the `_config.yml` file to change all the settings to reflect your site. Th
You can now visit your shiny new website, which will be seeded with several sample blog posts and a couple other pages. You can now visit your shiny new website, which will be seeded with several sample blog posts and a couple other pages.
**Note:** The GIF above goes through the setup for a user with username `daattalitest`. I only edited one setting in the `_config.yml` file in the video, but you should actually go through the rest of the settings as well. **Note:** The GIF above goes through the setup for a user with username `daattalitest`. I only edited one setting in the `_config.yml` file in the video, but **you should actually go through the rest of the settings as well.**
### Add your own content ### Add your own content
@ -46,6 +46,8 @@ YAML is a way to use parameters to make the templating more useful. To take adva
If you want to use any parameters, write them between the two lines. Look at `aboutme.md` or `index.html` as examples. If you want to use any parameters, write them between the two lines. Look at `aboutme.md` or `index.html` as examples.
**Always add the YAML front matter to every page, unless you specifically know that you want to bypass Jekyll.**
### Features ### Features
#### Mobile-first #### Mobile-first
@ -57,9 +59,9 @@ Many personalization settings in `_config.yml`, such as setting your avatar to a
#### Page types #### Page types
- To write a blog post, place a file in the `_posts` folder and assign `layout: post` in the YAML front matter. Look at the existing blog post files to see the YAML parameters that blog posts can use. - **post** - To write a blog post, place a file in the `_posts` folder and assign `layout: post` in the YAML front matter. Look at the existing blog post files to see the YAML parameters that blog posts can use.
- To add a non-blog page, place it in the root directory and assign `layout: page` in the YAML front matter. Look at `aboutme.md` and `index.html` as examples. - **page** - To add a non-blog page, place it in the root directory and assign `layout: page` in the YAML front matter. Look at `aboutme.md` and `index.html` as examples.
- To add a random page with minimal styling (ie. without the bulky navigation bar and footer), assign `layout: minimal`. - **minimal** - To add a random page with minimal styling (ie. without the bulky navigation bar and footer), assign `layout: minimal`.
- To write your own HTML page and completely bypass the Jekyll engine, simply omit the YAML front matter. - To write your own HTML page and completely bypass the Jekyll engine, simply omit the YAML front matter.
#### YAML front matter parameters #### YAML front matter parameters