jekyll-theme-paperwiki 0.1.15 → 0.1.16

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: fd08c7decaf64ebe150c286bdc708bb79f63d00ff64dd994ed043b67c7759684
4
- data.tar.gz: 77f5ea45e3aa6898043665adcf2609a89077e6b65fae8648d3b35e1c00ebbf59
3
+ metadata.gz: 1896b6de7d51495d6bdf12f3cc9aac56bb2573fcf80ce429725fee3593762b91
4
+ data.tar.gz: 18e1e6d0a06dffaff1f3ab69f29464186573086d0ade1df15cea4b45085cf568
5
5
  SHA512:
6
- metadata.gz: 9855dbdab93d99c3f65a46a5181c4a419c6cc16d57c93fbaa5acd14fd4d9974b921d856eede85c4afadaa316da5829e7fe0acca3680220a46ddd1369ecbd7486
7
- data.tar.gz: 2b53be0724d0eda18ba0d6151ea0b8eea8a7641e63fe8f22c94d8503eb7cebfe8d1151acd8adf8c283230f058a90bc6f74842124ad9f9c8787de02b8070f71f1
6
+ metadata.gz: 894e88cf0db6b281bd2ab322009df722df6859da06b9e6471c8088ebb80e4e500ef58b6ea6bc78e8a0d3d5eac35c92a5f22147de733c255e00fb9e17f42b1947
7
+ data.tar.gz: daa223a3bea9974c308e1fa6c726fee01e64d494586f827ef30d58c7d964ce8c24c0a523acb4969bc4cb5e1054d0eb397c2f8970ed2f1ef9ede4b63e910672de
data/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # jekyll-theme-paperwiki
2
2
 
3
- ![](/screenshot.png)
3
+ ![](/assets/images/homepage.png)
4
4
 
5
5
  For storing your worldbuilding notes! The intent of this theme is to get all the code out of the way and to allow you to write Markdown articles; the best way to do that is to install the theme as a gem. However, if you want to tinker with the code, just download this repository.
6
6
 
@@ -29,7 +29,7 @@ This theme comes with all of these prepackaged, so most of what you have to do i
29
29
 
30
30
  ## Installation
31
31
 
32
- [Install Jekyll](https://jekyllrb.com/docs/). Create a new site by running the following in your terminal:
32
+ [Install Jekyll](https://jekyllrb.com/docs/). If you're using the example site linked above, you can skip ahead to the [using the wiki](#using-the-wiki) section. Otherwise, create a new site by running the following in your terminal:
33
33
 
34
34
  ```
35
35
  $ jekyll new MYSITENAME
@@ -92,9 +92,11 @@ layout: launchpad
92
92
 
93
93
  This will show you the default wiki homepage. The three links - explore, contents, and random page - link to pages that are included with the theme, and consist of pregenerated content based on the wiki articles you've written. Now you can start adding articles in your `_wiki` folder.
94
94
 
95
+
96
+
95
97
  ### Using the wiki
96
98
 
97
- All of your wiki pages should be written in markdown, and you must begin each `.md` file like so:
99
+ All of your wiki pages should be written in Markdown, and you must begin each `.md` file like so:
98
100
 
99
101
  ```
100
102
  ---
@@ -107,51 +109,7 @@ Caveats:
107
109
  - If the site won't build due to an error with the random page, make sure you have more than one wiki article for it to draw from
108
110
  - You may need to specify a permalink and a title if you want to use certain characters that are not allowed in filenames -- say, some IPA characters. Otherwise just title your articles "Article title.md", with spaces, not underscores or hyphens, and the default settings will take care of the rest.
109
111
 
110
-
111
-
112
- ## Config
113
-
114
- By default, PaperWiki is set up to just be a collection of articles, with a handful of navigational pages, similar to Wikipedia. The articles are organized into the `collections` folder, in a subfolder titled `_wiki`. This is defined in the theme's config file like so:
115
-
116
- ```yaml
117
- collections_dir: collections
118
- collections:
119
- wiki:
120
- output: true
121
- permalink: /:collection/:name
122
- ```
123
-
124
- `/:collection/:name` means the url to each wiki entry will be `wiki/article-title` without the article file extension.
125
-
126
- However, if you would like to have additional collections akin to the Wikimedia Foundation's other projects - such as Wikisource, Wikispecies, or Wiktionary - then you can specify them in the same format as above, also under the `collections` key:
127
-
128
- ```yaml
129
- collections:
130
- COLLECTION_NAME:
131
- output: true
132
- permalink: /:collection/:name
133
- ```
134
-
135
- Make sure to add the corresponding folders within `collections`, including the preceding underscore: `_literature`, `_dictionary`, etc.
136
-
137
- Add into your `_config.yml`:
138
-
139
- ```yaml
140
- multi_projects: true
141
- ```
142
-
143
- You will also need to add a data file listing your projects: create a folder titled `_data` and inside it a file titled `projects.yml`. Within it you need to list the following, formatted in the same way:
144
-
145
- ``` yaml
146
- - name: Wiki
147
- link: /wiki
148
- icon: ri-global-line
149
- desc: A brief description here
150
- ```
151
-
152
- For the icon, find one you like from [RemixIcon](https://remixicon.com/) and copy the code.
153
-
154
- This will add links to each different collection on your homepage, and allow you to limit the scope of your searches to a single collection or expand it to cover all of them at once. The search logic is already taken care of in the theme itself; it just needs the names of your collections.
112
+ If you're unfamiliar with Markdown, see [here](https://www.markdownguide.org/).
155
113
 
156
114
 
157
115
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jekyll-theme-paperwiki
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.15
4
+ version: 0.1.16
5
5
  platform: ruby
6
6
  authors:
7
7
  - pomeloshark
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-06-22 00:00:00.000000000 Z
11
+ date: 2023-09-04 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: jekyll
@@ -44,7 +44,6 @@ files:
44
44
  - _layouts/collections.html
45
45
  - _layouts/default.html
46
46
  - _layouts/entry.html
47
- - _layouts/grammar.html
48
47
  - _layouts/launchpad.html
49
48
  - _layouts/page.html
50
49
  - _layouts/portal.html
@@ -54,7 +53,6 @@ files:
54
53
  - _layouts/search.html
55
54
  - _layouts/search_global.html
56
55
  - _layouts/wiki.html
57
- - _layouts/work.html
58
56
  - _sass/partials/_base.scss
59
57
  - _sass/partials/_blog.scss
60
58
  - _sass/partials/_collections.scss
@@ -1,11 +0,0 @@
1
- ---
2
- layout: entry
3
- ---
4
-
5
- <article class="entry entry-grammar">
6
-
7
- <h1>{{ page.title }}</h1>
8
-
9
- {{ content }}
10
-
11
- </article>
data/_layouts/work.html DELETED
@@ -1,17 +0,0 @@
1
- ---
2
- layout: entry
3
- ---
4
-
5
- <article class="entry entry_work">
6
-
7
- <h1>
8
- {{ page.title }}
9
- </h1>
10
-
11
- {% if page.format==verse %}
12
- <section class="entry_work-verse">{{ content }}</section>
13
- {% else %}
14
- {{ content }}
15
- {% endif %}
16
-
17
- </article>