jekyll-crisp-theme 1.0.0.beta1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (28) hide show
  1. checksums.yaml +7 -0
  2. data/LICENSE +21 -0
  3. data/README.md +124 -0
  4. data/_includes/disqus.html +14 -0
  5. data/_includes/footer.html +12 -0
  6. data/_includes/google_analytics.html +11 -0
  7. data/_includes/head.html +19 -0
  8. data/_includes/header.html +15 -0
  9. data/_includes/syntax_highlight.html +4 -0
  10. data/_layouts/default.html +18 -0
  11. data/_layouts/index.html +11 -0
  12. data/_layouts/page.html +8 -0
  13. data/_layouts/post.html +14 -0
  14. data/_layouts/redirect.html +20 -0
  15. data/_sass/_archive.scss +34 -0
  16. data/_sass/_article.scss +142 -0
  17. data/_sass/_code-highlight.scss +26 -0
  18. data/_sass/_footer.scss +62 -0
  19. data/_sass/_main.scss +73 -0
  20. data/_sass/_menu.scss +70 -0
  21. data/_sass/_page.scss +17 -0
  22. data/_sass/_things.scss +53 -0
  23. data/assets/css/style.scss +26 -0
  24. data/assets/css/tomorrow-night-eighties.css +74 -0
  25. data/assets/css/zenburn.css +80 -0
  26. data/assets/scripts/highlight.pack.js +2 -0
  27. data/assets/scripts/jquery-3.1.0.min.js +4 -0
  28. metadata +98 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 69165e8193ee8fc59499bc3bac387a49386fef7a
4
+ data.tar.gz: da8b546348cccda2ab7a2baafa8ad837cde7e356
5
+ SHA512:
6
+ metadata.gz: c3ef11dcc769dbbecd46831a69a3e43c941637e53c769717fba8c90c11d3b070019f58eb0d2ec3fdbd4414ceae5531cf57a10d7ce7fc0db16b0cd43ff3010ce8
7
+ data.tar.gz: 11c321e60698ab33f995238c4cbf610da5487be4a95267d4d5e67939444d95c7789de9f238fb63a50ea13b262643d13a8908a01c8f7ce8aae7a6c9db487d163c
data/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 David Zhang
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,124 @@
1
+ # Jekyll Crisp Minimalism Theme
2
+
3
+ Minimalism theme of Jekyll from Crisp.
4
+
5
+ [Sample Site](https://crispgm.github.io/jekyll-crisp-theme/)
6
+
7
+ ![Screenshot](/screenshot.jpg)
8
+
9
+ ## Installation
10
+
11
+ 1. To install a theme, first, add the theme to your site's `Gemfile`:
12
+
13
+ ```
14
+ gem 'jekyll-crisp-theme'
15
+ ```
16
+
17
+ 2. Save the changes to your `Gemfile`
18
+ 3. Run the command `bundle install` to install the theme
19
+ 4. Finally, activate the theme by adding the following to your site's `_config.yml`:
20
+
21
+ ```
22
+ theme: jekyll-crisp-theme
23
+ ```
24
+
25
+ For more information, please read [https://jekyllrb.com/docs/themes/](https://jekyllrb.com/docs/themes/).
26
+
27
+ ## Contents
28
+
29
+ ### Layouts
30
+
31
+ * `default.html`: The base layout that lays the foundation for subsequent layouts. The derived layouts inject their contents into this file at the line that says `{{ content }}` and are linked to this file via FrontMatter declaration `layout: default`.
32
+ * `page.html`: The layout for your documents that contain FrontMatter, but are not posts.
33
+ * `post.html`: The layout for your posts.
34
+ * `redirect.html`: The layout for redirections, which redirects following the FrontMatter `redirect_to`.
35
+
36
+ ### Includes
37
+
38
+ * `disqus.html`: Code to markup disqus comment box.
39
+ * `footer.html`: Defines the site's footer section.
40
+ * `google_analytics.html`: Inserts Google Analytics module (active only in production environment).
41
+ * `head.html`: Code-block that defines the `<head></head>` in _default_ layout.
42
+ * `header.html`: Defines the site's main header section. By default, pages with a defined `title` attribute will have links displayed here.
43
+
44
+ ### Sass
45
+
46
+ * `style.scss`: Defines the variable defaults for the theme and also further imports sass partials to supplement itself.
47
+ * `_main.scss`: Defines the base styles for various HTML elements.
48
+ * `_archive.scss`: Defines the styles for archive list.
49
+ * `_article.scss`: Defines the styles for articles.
50
+ * `_code-highlight.scss`: Defines the styles for syntax-highlighting.
51
+ * `_footer.scss`: Defines the styles for footer.
52
+ * `_menu.scss`: Defines the styles for header(menu).
53
+ * `_page.scss`: Defines the styles for page.
54
+ * `_things.scss`: Defines the styles for project list.
55
+
56
+ ### Assets
57
+
58
+ This directory includes sufficient css, js, and images used for the theme.
59
+
60
+ ## Usage
61
+
62
+ ### FrontMatter Variables
63
+
64
+ * `disable_syntax_highlight`: Default to `false`. By setting `true`, `highlight.js` will not be loaded or initiated. Recommended for non-code pages.
65
+ * `jquery`: Default to `false`. By setting `true`, `jQuery` will be loaded.
66
+
67
+ ### Menu
68
+
69
+ Header menu can be customized. Add *original* file (not target file) path to `site.menu`.
70
+
71
+ ```
72
+ menu:
73
+ - my_md_page.md
74
+ - my_html_page.html
75
+ ```
76
+
77
+ ### Contact Icons
78
+
79
+ Contact icons can be set in `site.contact`. To add more contact icons, attach new items with `link` and `icon` to your target position.
80
+
81
+ ```
82
+ contact:
83
+ - link: https://crispgm.github.io/jekyll-crisp-theme/
84
+ icon: fa-globe
85
+ ```
86
+
87
+ ### Project
88
+
89
+ Project page is a place to show the information sheet of your projects. You may use `_data` file to organize the page, or even use `github-metadata` to do that.
90
+
91
+ ### Disqus
92
+
93
+ Optionally, if you have a Disqus account, you can tell Jekyll to use it to show a comments section below each post.
94
+
95
+ To enable it, add the following lines to your Jekyll site:
96
+
97
+ ```yaml
98
+ disqus:
99
+ shortname: my_disqus_shortname
100
+ ```
101
+
102
+ You can find out more about Disqus' shortnames [here](https://help.disqus.com/customer/portal/articles/466208).
103
+
104
+ Comments are enabled by default and will only appear in production, i.e., `JEKYLL_ENV=production`
105
+
106
+ If you don't want to display comments for a particular post you can disable them by adding `comments: false` to that post's YAML Front Matter.
107
+
108
+ ### Google Analytics
109
+
110
+ To enable Google Anaytics, add the following lines to your Jekyll site:
111
+
112
+ ```yaml
113
+ google_analytics: UA-NNNNNNNN-N
114
+ ```
115
+
116
+ Google Analytics will only appear in production, i.e., `JEKYLL_ENV=production`
117
+
118
+ ## Contributing
119
+
120
+ Bug reports and pull requests are welcome on GitHub at <https://github.com/crispgm/jekyll-crisp-theme>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org/) code of conduct.
121
+
122
+ ## License
123
+
124
+ MIT
data/_includes/disqus.html ADDED
@@ -0,0 +1,14 @@
1
+ {% if jekyll.environment == 'production' and page.layout == 'post' and page.comments != 'false' %}
2
+ <script>
3
+ var disqus_config = function () {
4
+ this.page.identifier = '{{ page.permalink }}';
5
+ };
6
+
7
+ (function() { // DON'T EDIT BELOW THIS LINE
8
+ var d = document, s = d.createElement('script');
9
+ s.src = 'https://{{ site.disqus.shortname }}.disqus.com/embed.js';
10
+ s.setAttribute('data-timestamp', +new Date());
11
+ (d.head || d.body).appendChild(s);
12
+ })();
13
+ </script>
14
+ {% endif %}
data/_includes/footer.html ADDED
@@ -0,0 +1,12 @@
1
+ <footer>
2
+ <div class="content-wrapper contact" id="contact">
3
+ <div class="contact-links">
4
+ {% for item in site.contact %}
5
+ <a href="{{ item.account }}"><i class="fa {{ item.icon }}"></i></a>
6
+ {% endfor %}
7
+ </div>
8
+ <div class="contact-copyright">
9
+ {{ site.author }} &copy; {{ site.time | date: "%Y" }}
10
+ </div>
11
+ </div>
12
+ </footer>
data/_includes/google_analytics.html ADDED
@@ -0,0 +1,11 @@
1
+ {% if jekyll.environment == 'production' and site.google_analytics %}
2
+ <script>
3
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
4
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
5
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
6
+ })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
7
+
8
+ ga('create', '{{ site.google_analytics }}', 'auto');
9
+ ga('send', 'pageview');
10
+ </script>
11
+ {% endif %}
data/_includes/head.html ADDED
@@ -0,0 +1,19 @@
1
+ <head>
2
+ <meta charset="UTF-8">
3
+ <meta name="description" content="{{ site.description }}"/>
4
+ <title>{{ page.title }} | {{ site.title }}</title>
5
+ <meta name="viewport" content="width=device-width, initial-scale=1">
6
+ <link href="//fonts.googleapis.com/css?family=Noto+Sans" rel="stylesheet">
7
+ <link href="//fonts.googleapis.com/css?family=Source+Code+Pro" rel="stylesheet">
8
+ <link rel="icon" type="image/x-icon" href="/image/logo.png">
9
+ {% if page.font_awesome != false %}
10
+ <link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet">
11
+ {% endif %}
12
+ {% if page.syntax_highlight != false %}
13
+ <link rel="stylesheet" href="{{ "/assets/css/tomorrow-night-eighties.css" | relative_url }}">
14
+ {% endif %}
15
+ {% if page.jquery == true %}
16
+ <script src="{{ "/assets/scripts/jquery-3.1.0.min.js" | relative_url }}"></script>
17
+ {% endif %}
18
+ <link rel="stylesheet" href="{{ "/assets/css/style.css" | relative_url }}">
19
+ </head>
data/_includes/header.html ADDED
@@ -0,0 +1,15 @@
1
+ <header class="content-wrapper menu">
2
+ <div class="menu-home">
3
+ <a href="{{ "/" | relative_url }}">{{ site.title }}</a>
4
+ </div>
5
+ <div class="menu-links">
6
+ {% assign default_paths = site.pages | map: "path" %}
7
+ {% assign page_paths = site.menu | default: default_paths %}
8
+ {% for path in page_paths %}
9
+ {% assign item = site.pages | where: "path", path | first %}
10
+ <div class="menu-item{% if page.title == item.title %}{{ " menu-active" }}{% endif %}">
11
+ <a href="{{ item.url | relative_url }}">{{ item.title }}</a>
12
+ </div>
13
+ {% endfor %}
14
+ </div>
15
+ </header>
data/_includes/syntax_highlight.html ADDED
@@ -0,0 +1,4 @@
1
+ {% if page.disable_syntax_highlight != true %}
2
+ <script src="{{ "/assets/scripts/highlight.pack.js" | relative_url }}"></script>
3
+ <script>hljs.initHighlightingOnLoad();</script>
4
+ {% endif %}
data/_layouts/default.html ADDED
@@ -0,0 +1,18 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ {% include head.html %}
4
+ <body>
5
+ <div class="content" id="header">
6
+ {% include header.html %}
7
+ </div>
8
+ <div class="content" id="main-content">
9
+ <div class="content-wrapper">
10
+ {{ content }}
11
+ </div>
12
+ </div>
13
+ {% include footer.html %}
14
+ {% include syntax_highlight.html %}
15
+ {% include disqus.html %}
16
+ {% include google_analytics.html %}
17
+ </body>
18
+ </html>
data/_layouts/index.html ADDED
@@ -0,0 +1,11 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ {% include head.html %}
4
+ <body>
5
+ <div class="index-wrapper">
6
+ <div class="index">
7
+ {{ content }}
8
+ </div>
9
+ </div>
10
+ </body>
11
+ </html>
data/_layouts/page.html ADDED
@@ -0,0 +1,8 @@
1
+ ---
2
+ layout: default
3
+ ---
4
+ <div class="page">
5
+ <div class="page-main">
6
+ {{ content }}
7
+ </div>
8
+ </div>
data/_layouts/post.html ADDED
@@ -0,0 +1,14 @@
1
+ ---
2
+ layout: default
3
+ ---
4
+ <div class="article">
5
+ <div class="article-head">
6
+ <div class="article-title">{{page.title}}</div>
7
+ <div class="article-date">{{page.date | date:"%B %d, %Y"}}</div>
8
+ </div>
9
+ <div class="article-main">
10
+ {{ content }}
11
+ </div>
12
+ <div id="disqus_thread" class="article-comment"></div>
13
+ <noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript" rel="nofollow">comments powered by Disqus.</a></noscript>
14
+ </div>
data/_layouts/redirect.html ADDED
@@ -0,0 +1,20 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ {% include head.html %}
4
+ <body>
5
+ <div class="content" id="header">
6
+ {% include header.html %}
7
+ </div>
8
+ <div class="content" id="main-content">
9
+ <div class="content-wrapper">
10
+ <div class="page">
11
+ Redirecting to <a href="{{ page.redirect_to }}">{{ page.redirect_to }}</a>
12
+ </div>
13
+ </div>
14
+ </div>
15
+ {% include footer.html %}
16
+ </body>
17
+ <script>
18
+ location.href = '{{ page.redirect_to }}';
19
+ </script>
20
+ </html>
data/_sass/_archive.scss ADDED
@@ -0,0 +1,34 @@
1
+ // Theme of Crisp Blog
2
+ // Copyright(c) David Zhang, 2017
3
+
4
+ .archive-main {
5
+ margin: 1rem 0;
6
+
7
+ a {
8
+ text-decoration: none;
9
+
10
+ &:hover {
11
+ text-decoration: underline;
12
+ }
13
+ }
14
+
15
+ .archive-item {
16
+ line-height: 1.8rem;
17
+ margin-top: .6rem;
18
+ overflow: auto;
19
+
20
+ .archive-date {
21
+ color: $light-color;
22
+ font-size: .8rem;
23
+ margin: 0;
24
+ }
25
+ }
26
+ }
27
+
28
+ .archive-more {
29
+ color: $light-color;
30
+
31
+ a {
32
+ color: $light-color;
33
+ }
34
+ }
data/_sass/_article.scss ADDED
@@ -0,0 +1,142 @@
1
+ // Theme of Crisp Blog
2
+ // Copyright(c) David Zhang, 2017
3
+
4
+ .article {
5
+ margin-bottom: 2rem;
6
+ text-align: left;
7
+
8
+ .article-head {
9
+ margin-bottom: 4.2rem;
10
+ margin-top: 4.2rem;
11
+ text-align: left;
12
+
13
+ .article-title {
14
+ color: $sub-color;
15
+ font-size: 2.2rem;
16
+ }
17
+
18
+ .article-date {
19
+ color: $light-color;
20
+ font-size: 1rem;
21
+ margin-top: 1rem;
22
+ }
23
+ }
24
+
25
+ .article-main {
26
+ font-size: 1rem;
27
+ margin-bottom: 3.2rem;
28
+ margin-top: 1.2rem;
29
+ }
30
+
31
+ // disqus
32
+ .article-comment {
33
+ iframe {
34
+ text-align: center;
35
+ }
36
+ }
37
+ }
38
+
39
+ h1 {
40
+ color: $sub-color;
41
+ font-size: 2.4rem;
42
+ font-weight: 400;
43
+ padding-bottom: 1.2rem;
44
+ padding-top: 1.6rem;
45
+ text-align: left;
46
+ }
47
+
48
+ h2 {
49
+ color: $sub-color;
50
+ font-size: 2rem;
51
+ font-weight: 400;
52
+ padding-bottom: 1.2rem;
53
+ padding-top: 1.4rem;
54
+ text-align: left;
55
+ }
56
+
57
+ h3 {
58
+ color: $sub-color;
59
+ font-size: 1.5rem;
60
+ font-weight: 500;
61
+ padding-bottom: 1.2rem;
62
+ padding-top: 1.2rem;
63
+ text-align: left;
64
+ }
65
+
66
+ h4 {
67
+ color: $sub-color;
68
+ font-size: 1.2rem;
69
+ font-weight: 600;
70
+ padding-bottom: .8rem;
71
+ padding-top: .8rem;
72
+ text-align: left;
73
+ }
74
+
75
+ h5 {
76
+ color: $sub-color;
77
+ font-size: 1rem;
78
+ font-weight: 700;
79
+ padding-bottom: 0;
80
+ padding-top: .8rem;
81
+ text-align: left;
82
+ }
83
+
84
+ blockquote {
85
+ border-left: .2rem solid $border-color;
86
+ margin-left: 0;
87
+ padding-left: 1rem;
88
+ }
89
+
90
+ p {
91
+ hyphens: auto;
92
+ line-height: 1.8rem;
93
+ margin-top: 1.5rem;
94
+ }
95
+
96
+ sup {
97
+ font-size: .6rem;
98
+ line-height: .6rem;
99
+ vertical-align: auto;
100
+ }
101
+
102
+ hr {
103
+ margin-bottom: 3rem;
104
+ margin-top: 3rem;
105
+ width: 3rem;
106
+ }
107
+
108
+ ul {
109
+ p {
110
+ margin: 0;
111
+ }
112
+
113
+ li {
114
+ line-height: 1.8rem;
115
+ margin-left: -1rem;
116
+
117
+ p {
118
+ line-height: 1.8rem;
119
+ margin: 0;
120
+ }
121
+ }
122
+ }
123
+
124
+ table {
125
+ border-collapse: collapse;
126
+ width: 100%;
127
+
128
+ tr {
129
+ &:hover {
130
+ background-color: $light-color;
131
+ }
132
+
133
+ th {
134
+ background-color: $light-color;
135
+ padding: .2rem .4rem;
136
+ }
137
+
138
+ td {
139
+ padding: .2rem .4rem;
140
+ }
141
+ }
142
+ }