Skip to content
This repository was archived by the owner on Jan 10, 2021. It is now read-only.

Commit f767c7a

Browse files
chrisanthropicchrisanthropic
committed
sass documentation
1 parent fb1dd51 commit f767c7a

9 files changed

+280
-1
lines changed

‎_data/nav.yml

+4
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@
1414
subhref: "/documentation/social-icons/"
1515
- subtitle: "header-image"
1616
subhref: "/documentation/header-image/"
17+
- subtitle: "seo"
18+
subhref: "/documentation/seo/"
19+
- subtitle: "sass"
20+
subhref: "/documentation/sass/"
1721

1822
- title: "blog"
1923
href: "/blog/"

‎_pages/sass.md

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
layout: page
3+
title: sass
4+
permalink: "/documentation/sass"
5+
---
6+
# Sass Configuration
7+
`_sass/variables.scss` includes the following variables for easy customization:
8+
9+
**Base Colors**
10+
- $primary-color
11+
- $secondary-color
12+
- $complimentary-color
13+
- $body-bg
14+
- $body-font-color
15+
16+
**Links**
17+
- $link-color
18+
- $link-hover-color
19+
- $link-visited-color
20+
21+
**Text**
22+
- $base-font-family
23+
- $base-font-size
24+
- $small-font-size
25+
- $base-line-height
26+
27+
**Header Settings**
28+
- $header-color
29+
- $header-link-color
30+
- $header-link-hover-color
31+
- $header-link-visted-color
32+
- $header-active-link-color
33+
34+
**Sidebar Settings**
35+
- $sidebar-color
36+
37+
**Mobile Navbar Settings**
38+
- $navbar-height
39+
- $navbar-color
40+
- $navbar-text-color
41+
- $navbar-hover-color
42+
- $navbar-active-color
43+
- $navbar-font-size
44+
- $navbar-font-family
45+
- $hamburger-icon-color
46+
47+
**Socials Navbar Settings**
48+
- $socials-font-color
49+
- $socials-font-size
50+
51+
**Gallery Lightbox Pop-Up**
52+
- $lightbox-background-color
53+
- $lightbox-border-color
54+
- $lightbox-description-background-color
55+
- $lightbox-description-text-color
56+
- $lightbox-caption-text-color
57+
- $lightbox-navigation-color
58+
59+
**Utility**
60+
- $spacing-unit
61+
62+
**Layout Settings**
63+
- $header-margin
64+
65+
**Buttons**
66+
- $button-color
67+
- $button-hover
68+
- $button-text-color

‎_pages/seo.md

+111
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
---
2+
layout: page
3+
title: seo
4+
permalink: "/documentation/seo/"
5+
---
6+
# SEO
7+
This theme uses the following options SEO options:
8+
- [Keyword Metadata](#keyword-metadata)
9+
- [Description Metadata](#description-metadata)
10+
- [Google Analytics](#google-analytics)
11+
- [Facebook Open Graph](#facebook-open-graph)
12+
- [Twitter Cards](#twitter-cards)
13+
14+
--------
15+
## Keyword Metadata
16+
### Sitewide Defaults
17+
If you set keywords via `_config.yml` they will be used as the default keywords for the metadata for each page.
18+
19+
**Example**
20+
```
21+
keywords: jekyll, jekyll theme, portfolio theme, artist theme
22+
```
23+
24+
### Per Page
25+
You can override the `_config.yml` defaults for any page or post by adding the following to it's yaml frontmatter.
26+
27+
**Example**
28+
```
29+
keywords: "different, words, than the defaults"
30+
```
31+
32+
--------
33+
## Description Metadata
34+
### Sitewide Defaults
35+
If you set a description via `_config.yml` it will be used as the default description for the metadata for each page.
36+
37+
**Example**
38+
```
39+
description: A witty description.
40+
```
41+
42+
### Per Page
43+
You can override the `_config.yml` defaults for any page or post by adding the following to it's yaml frontmatter.
44+
45+
**Example**
46+
```
47+
description: "An even wittier description."
48+
```
49+
50+
--------
51+
## Google Analytics*
52+
- *Uses Javascript
53+
- Enable by adding the following code to your `_config.yml`
54+
```
55+
google_universal_analytics: YOUR-ANALYTICS-ID
56+
google_universal_analytics_cookiedomain: auto
57+
```
58+
- Replace YOUR-ANALYTICS-ID with your actual analytics ID.
59+
60+
--------
61+
## Facebook Open Graph
62+
### Sitewide Defaults
63+
Enable by filling out the following in your `config.yml`
64+
65+
```
66+
facebook_app_id:
67+
facebook_locale: en_US
68+
facebook_page: https://www.facebook.com/YOUR-ACCOUNT
69+
facebook_image: images/author.jpg
70+
```
71+
72+
- facebook_app_id: [Get One Here](https://developers.facebook.com/?advanced_app_create=true)
73+
- facebook_locale: your locale
74+
- facebook_page: the link to your facebook page
75+
- facebook_image: the default image to use when someone shares your post/page on Facebook
76+
- this image should be at least 200x200 pixels
77+
78+
### Per Page
79+
You can set a custom opengraph metadata per page/post by adding the following to it's yaml frontmatter:
80+
81+
```
82+
facebook_image: /images/path-to-your-image.jpg
83+
facebook_type: article
84+
```
85+
- facebook_image: the path to the image you want displayed when shared on Facebook. 200x200 pixel minimum.
86+
- facebook_type: defaults to 'article'
87+
- other options at [http://ogp.me/#types](http://ogp.me/#types)
88+
89+
---------
90+
## Twitter Cards
91+
### Sitewide Defaults
92+
Fill out the following in your config.yml
93+
94+
```
95+
twitter_user: YOUR-USER
96+
twitter_card: true
97+
twitter_image: images/author.jpg
98+
```
99+
- twitter_user: Enter your username (no @ before it)
100+
- twitter_card: true/false
101+
- enables/disables twitter cards
102+
- twitter_image: the default image to use when someone shares your post/page on Facebook
103+
- this image should be at least 200x200 pixels
104+
105+
### Per Page
106+
You can set a custom Twitter card metadata per page/post by adding the following to it's yaml frontmatter:
107+
108+
```
109+
twitter_image: /images/path-to-your-image.jpg
110+
```
111+
- twitter_image: the path to the image you want displayed when shared on Facebook. 200x200 pixel minimum.

‎_posts/2016-08-15-sample-post-with-thumbnail.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
layout: post
3+
title: "Sample post with thumbnail"
4+
5+
keywords: Shamsee, Lone Idiot and Cub, Tristan J. Tarwater, Adrian Ricker
6+
description: Shamsee Lone Idiot and Cub - page 013
7+
8+
thumbnail: images/posts/thumbs/catmen.jpg
9+
10+
facebook_type:
11+
facebook_image: images/posts/catmen.jpg
12+
---
13+
Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo.
14+
15+
Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem.
16+
17+
Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?
18+
19+
At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati cupiditate non provident, similique sunt in culpa qui officia deserunt mollitia animi, id est laborum et dolorum fuga. Et harum quidem rerum facilis est et expedita distinctio. Nam libero tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere

‎_posts/2016-08-16-sample-post-with-thumbnail.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
layout: post
3+
title: "Sample post with thumbnail"
4+
5+
keywords: Shamsee, Lone Idiot and Cub, Tristan J. Tarwater, Adrian Ricker
6+
description: Shamsee Lone Idiot and Cub - page 013
7+
8+
thumbnail: images/posts/thumbs/catmen.jpg
9+
10+
facebook_type:
11+
facebook_image: images/posts/catmen.jpg
12+
---
13+
Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo.
14+
15+
Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem.
16+
17+
Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?
18+
19+
At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati cupiditate non provident, similique sunt in culpa qui officia deserunt mollitia animi, id est laborum et dolorum fuga. Et harum quidem rerum facilis est et expedita distinctio. Nam libero tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere

‎_posts/2016-08-17-sample-post-with-thumbnail.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
layout: post
3+
title: "Sample post with thumbnail"
4+
5+
keywords: Shamsee, Lone Idiot and Cub, Tristan J. Tarwater, Adrian Ricker
6+
description: Shamsee Lone Idiot and Cub - page 013
7+
8+
thumbnail: images/posts/thumbs/catmen.jpg
9+
10+
facebook_type:
11+
facebook_image: images/posts/catmen.jpg
12+
---
13+
Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo.
14+
15+
Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem.
16+
17+
Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?
18+
19+
At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati cupiditate non provident, similique sunt in culpa qui officia deserunt mollitia animi, id est laborum et dolorum fuga. Et harum quidem rerum facilis est et expedita distinctio. Nam libero tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere

‎_posts/2016-08-18-sample-post-with-thumbnail.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
layout: post
3+
title: "Sample post with thumbnail"
4+
5+
keywords: Shamsee, Lone Idiot and Cub, Tristan J. Tarwater, Adrian Ricker
6+
description: Shamsee Lone Idiot and Cub - page 013
7+
8+
thumbnail: images/posts/thumbs/catmen.jpg
9+
10+
facebook_type:
11+
facebook_image: images/posts/catmen.jpg
12+
---
13+
Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo.
14+
15+
Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem.
16+
17+
Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?
18+
19+
At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati cupiditate non provident, similique sunt in culpa qui officia deserunt mollitia animi, id est laborum et dolorum fuga. Et harum quidem rerum facilis est et expedita distinctio. Nam libero tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere

‎_posts/2016-08-19-sample-post-with-thumbnail.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
layout: post
3+
title: "Sample post with thumbnail"
4+
5+
keywords: Shamsee, Lone Idiot and Cub, Tristan J. Tarwater, Adrian Ricker
6+
description: Shamsee Lone Idiot and Cub - page 013
7+
8+
thumbnail: images/posts/thumbs/catmen.jpg
9+
10+
facebook_type:
11+
facebook_image: images/posts/catmen.jpg
12+
---
13+
Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo.
14+
15+
Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem.
16+
17+
Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?
18+
19+
At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati cupiditate non provident, similique sunt in culpa qui officia deserunt mollitia animi, id est laborum et dolorum fuga. Et harum quidem rerum facilis est et expedita distinctio. Nam libero tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere

‎notes

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
--------------------
22
Documentation
3-
- frontmatter (permalink, sidebar, facebook, twitter, )
3+
X frontmatter (permalink, sidebar, facebook, twitter, )
44
X galleries
55
X pages
66
- thumbnails
@@ -10,6 +10,7 @@ Documentation
1010
X socials
1111
X header image (sitewide and per page)
1212
X html-minify
13+
X SEO
1314

1415
Attribution
1516
- lightbox

0 commit comments

Comments
 (0)