jekyll-theme-crisp-wiki 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (6) hide show
  1. checksums.yaml +7 -0
  2. data/LICENSE +21 -0
  3. data/README.md +56 -0
  4. data/_data/wiki.yml +10 -0
  5. data/_layouts/wiki.html +48 -0
  6. metadata +89 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 19c8f90261d14e51fd5004ee25faa8d0359f503332998e38ecf36cd30eb1e4c3
4
+ data.tar.gz: 579d2d2438afd4c44b3a8793029928bac7a4ca8a7a68c4aae49ff7ba4f937136
5
+ SHA512:
6
+ metadata.gz: 5b1e6c2e8b36d59757b6224132ceebc941d9bf009fdfae90bfab313b70765c719fb586b73bfd9fbdbe7bc48ce6ff7ceae4f7afb0d999b4d930436a173a0a775a
7
+ data.tar.gz: 7a9d166cdb96b75f8721d1f906a3d4589fe6052c785dbf36227c979caf578791bfed1c1df9462aa638df759ffebc8b2ac5ba2d6eb0976423e66952960d97596f
data/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
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,56 @@
1
+ # Crisp Wiki Theme for Jekyll
2
+
3
+ ![](https://img.shields.io/badge/license-MIT-blue.svg)
4
+ ![](https://img.shields.io/badge/powered%20by-jekyll-red.svg)
5
+
6
+ A simple responsive wiki theme for Jekyll from Crisp.
7
+
8
+ I use it on my website <https://crispgm.com/wiki/>.
9
+
10
+ ## Installation
11
+
12
+ ### Manual
13
+
14
+ 1. Clone the project.
15
+
16
+ ```
17
+ git clone https://github.com/crispgm/wiki.git
18
+ ```
19
+
20
+ 2. Modify `_data/wiki.yml` to add your QAs.
21
+
22
+ ```yaml
23
+ - q: What is Jekyll?
24
+ a: It is a static site generator.
25
+ ```
26
+
27
+ 3. Run, debug & build with `jekyll`.
28
+
29
+ ```
30
+ # Run
31
+ jekyll serve
32
+ # Build
33
+ jekyll build
34
+ ```
35
+
36
+ ### Gem-based theme
37
+
38
+ 1. To install a theme, first, add the theme to your site's `Gemfile`:
39
+
40
+ ```
41
+ gem 'jekyll-theme-crisp-wiki'
42
+ ```
43
+
44
+ 2. Save the changes to your `Gemfile`
45
+ 3. Run the command `bundle install` to install the theme
46
+ 4. Finally, activate the theme by adding the following to your site's `_config.yml`:
47
+
48
+ ```
49
+ theme: jekyll-theme-crisp-wiki
50
+ ```
51
+
52
+ For more information, please read [https://jekyllrb.com/docs/themes/](https://jekyllrb.com/docs/themes/).
53
+
54
+ ## Sample
55
+
56
+ [[Sample Site](https://crisp.lol/wiki/)][[Screenshot](/screenshots/screenshot.jpg)]
data/_data/wiki.yml ADDED
@@ -0,0 +1,10 @@
1
+ - id: wednesday-thursday-friday
2
+ q: 英语中 Wednesday, Thursday, Friday 分别代表了什么？
3
+ a: 分别代表了奥丁、索尔、芙蕾雅。
4
+ - id: borussia-dortmund
5
+ q: 德甲劲旅多特蒙德队名中 Borussia Dortmund 中的 Borussia 是什么意思？
6
+ a: 普鲁士（Prussia）的拉丁文写法。
7
+ - id: linux-pronunciation
8
+ q: Linux 的正确读音是什么？
9
+ a: |
10
+ 详情请参考 <a href="http://www.paul.sladen.org/pronunciation/torvalds-says-linux.mp3">Linux Torvalds 本人的读音</a>。
data/_layouts/wiki.html ADDED
@@ -0,0 +1,48 @@
1
+ ---
2
+ layout: null
3
+ ---
4
+ <!DOCTYPE html>
5
+ <html>
6
+ <head>
7
+ <title>{{ site.title }}</title>
8
+ <meta charset="UTF-8">
9
+ <meta name="viewport" content="width=device-width, initial-scale=1">
10
+ <link rel="stylesheet" href="{{ site.baseurl }}/css/style.css">
11
+ </head>
12
+ <body>
13
+ <div class="container">
14
+ <header class="menu">
15
+ <div class="section">
16
+ <div class="section-wrap">
17
+ <a href="{{ site.baseurl }}/">Wiki</a>
18
+ <a href="{{ site.baseurl }}/home/">Home</a>
19
+ <a href="{{ site.baseurl }}/about/">About</a>
20
+ </div>
21
+ </div>
22
+ </header>
23
+ <div class="section">
24
+ {% for item in site.data.wiki %}
25
+ <div class="section-wrap" id="{{ item.id }}">
26
+ <div class="section-item">
27
+ <div class="section-title title-q">
28
+ </div>
29
+ <div class="section-content">
30
+ <a href="#{{ item.id }}">{{ item.q }}</a>
31
+ </div>
32
+ </div>
33
+ <div class="section-item">
34
+ <div class="section-title title-a">
35
+ </div>
36
+ <div class="section-content">
37
+ {{ item.a }}
38
+ </div>
39
+ </div>
40
+ </div>
41
+ {% endfor %}
42
+ </div>
43
+ </div>
44
+ <footer>
45
+ <div>Copyright &copy; {{ site.author }}, {{ site.time | date: "%Y" }}.</div>
46
+ </footer>
47
+ </body>
48
+ </html>
metadata ADDED
@@ -0,0 +1,89 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: jekyll-theme-crisp-wiki
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - David Zhang
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2019-07-16 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: jekyll
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '3.8'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '3.8'
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '2.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '2.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '10.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '10.0'
55
+ description:
56
+ email:
57
+ executables: []
58
+ extensions: []
59
+ extra_rdoc_files: []
60
+ files:
61
+ - LICENSE
62
+ - README.md
63
+ - _data/wiki.yml
64
+ - _layouts/wiki.html
65
+ homepage: https://github.com/crispgm/wiki
66
+ licenses:
67
+ - MIT
68
+ metadata:
69
+ plugin_type: theme
70
+ post_install_message:
71
+ rdoc_options: []
72
+ require_paths:
73
+ - lib
74
+ required_ruby_version: !ruby/object:Gem::Requirement
75
+ requirements:
76
+ - - "~>"
77
+ - !ruby/object:Gem::Version
78
+ version: '2.3'
79
+ required_rubygems_version: !ruby/object:Gem::Requirement
80
+ requirements:
81
+ - - ">="
82
+ - !ruby/object:Gem::Version
83
+ version: '0'
84
+ requirements: []
85
+ rubygems_version: 3.0.3
86
+ signing_key:
87
+ specification_version: 4
88
+ summary: A minimalist wiki template for Jekyll.
89
+ test_files: []