domain-jekyll 1.0.3 → 1.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +76 -12
- data/_layouts/Post.html +1 -1
- data/assets/.DS_Store +0 -0
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: e2d2e5a3d050c88e25afa08a4af02cace2b2c65704e91930221fee7c5d824708
|
|
4
|
+
data.tar.gz: d6bc5750c911c04d86bdec1483706f9edb17a1b83e815fde90c3824fc72e348d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c8517c78e2ccec1871b0f309c006b0598d2f31a549af72220bffc346ecbf45b3320d72be53d8ac41804781010e10d64b743c23ae176425577bdbd232c6b408e2
|
|
7
|
+
data.tar.gz: 879009e42a03da1c2738c82da41e48e4dbb045581bbf1f6890e9fc00834e199d32d2c0ffacb0863905908a30f98022eab88cc67a8c4eb44fead3917700095f35
|
data/README.md
CHANGED
|
@@ -1,24 +1,88 @@
|
|
|
1
|
-
# Domain
|
|
2
1
|
|
|
3
|
-
](https://github.com/Lumunix/Domain/blob/main/LICENSE)
|
|
3
|
+
[](https://jekyllrb.com/)
|
|
4
|
+
[](https://rubygems.org/gems/minimal-mistakes-jekyll)
|
|
5
|
+
[](https://www.paypal.me/Lumunix)
|
|
6
|
+
|
|
4
7
|
|
|
5
|
-
|
|
8
|
+
# [Domain](https://lumunix.github.io/Domain/)
|
|
6
9
|
Jekyll Knowledge Base / Blog Theme that provides wiki style linking, full text search and automatically generated post organization pages.
|
|
7
10
|
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
## Installation
|
|
17
|
+
|
|
18
|
+
- Option 1: Use the [Domain Github Pages Initializer](https://github.com/Lumunix/Domain-Github-Pages-Initializer)
|
|
19
|
+
- Option 2: Setup as a [gem-based theme](https://jekyllrb.com/docs/themes/#understanding-gem-based-themes)
|
|
20
|
+
- Option 3: Setup as a [remote theme](https://blog.github.com/2017-11-29-use-any-theme-with-github-pages/)
|
|
21
|
+
- Option 4: Forking/directly copying all of the theme files into your project.
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
### Gem-based method
|
|
25
|
+
|
|
26
|
+
With Gem-based themes, directories such as the `assets`, `_layouts`, `_includes`, and `_sass` are stored in the theme’s gem, hidden from your immediate view. Yet all of the necessary directories will be read and processed during Jekyll’s build process.
|
|
27
|
+
|
|
28
|
+
This allows for easier installation and updating as you don't have to manage any of the theme files. To install:
|
|
29
|
+
|
|
30
|
+
1. Add the following to your `Gemfile`:
|
|
31
|
+
|
|
32
|
+
```ruby
|
|
33
|
+
gem "domain-jekyll"
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
2. Fetch and update bundled gems by running the following [Bundler](http://bundler.io/) command:
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
bundle
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
3. Set the `theme` in your project's Jekyll `_config.yml` file:
|
|
43
|
+
|
|
44
|
+
```yaml
|
|
45
|
+
theme: domain-jekll
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
To update the theme run `bundle update`.
|
|
49
|
+
|
|
50
|
+
### Remote theme method
|
|
51
|
+
|
|
52
|
+
Remote themes are similar to Gem-based themes, but do not require `Gemfile` changes or whitelisting making them ideal for sites hosted with GitHub Pages.
|
|
53
|
+
|
|
54
|
+
To install:
|
|
55
|
+
|
|
56
|
+
1. Create/replace the contents of your `Gemfile` with the following:
|
|
57
|
+
|
|
58
|
+
```ruby
|
|
59
|
+
source "https://rubygems.org"
|
|
60
|
+
|
|
61
|
+
gem "github-pages", group: :jekyll_plugins
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
3. Fetch and update bundled gems by running the following [Bundler](http://bundler.io/) command:
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
bundle
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
4. Add `remote_theme: "Lumunix/Domain"` to your `_config.yml` file. Remove any other `theme:` or `remote_theme:` entry.
|
|
72
|
+
|
|
73
|
+
|
|
8
74
|
## Usage
|
|
9
75
|
|
|
10
|
-
|
|
76
|
+
For detailed instructions on how to configure, customize, read the [theme's documentation](https://lumunix.github.io/Domain/).
|
|
11
77
|
|
|
12
|
-
|
|
78
|
+
## Development Environment
|
|
79
|
+
Included in the repository is a [docker-compose](./docker-compose.yml) file that creates a container from the the official [Jekyll Docker Image](https://hub.docker.com/r/jekyll/jekyll/). This will allow you to setup a development environment without having to install Ruby and Jekyll manually and allow you to quickly test and preview changes.
|
|
13
80
|
|
|
14
|
-
3. In the directory you downloaded the project, open command line or terminal and run the following command.
|
|
15
81
|
|
|
16
|
-
|
|
17
|
-
docker-compose up
|
|
18
|
-
```
|
|
19
|
-
4. You should now be able to go to your web browser and view the site [Here](http://127.0.0.1:4000/)
|
|
82
|
+
1. Fork this repo. Clone it to your machine.
|
|
20
83
|
|
|
84
|
+
2. [Install Docker/Compose](https://docs.docker.com/compose/install/). You must have Docker and Compose installed.
|
|
21
85
|
|
|
22
|
-
|
|
86
|
+
3. In the directory you downloaded the project, open terminal and run the following command `docker compose up`.
|
|
23
87
|
|
|
24
|
-
|
|
88
|
+
4. You should now be able to go to your web browser and view the site [Here](http://127.0.0.1:4000/)
|
data/_layouts/Post.html
CHANGED
|
@@ -13,7 +13,7 @@ layout: Sidebar
|
|
|
13
13
|
{% endif %}
|
|
14
14
|
<header class="header-page">
|
|
15
15
|
<h1 class="page-title">{{page.title}}</h1>
|
|
16
|
-
<div class="page-date"><span>{{page.date | date: '%Y, %b %d'}}
|
|
16
|
+
<div class="page-date"><span>{{page.date | date: '%Y, %b %d'}}</span></div>
|
|
17
17
|
</header>
|
|
18
18
|
{%- include Content.html -%}
|
|
19
19
|
{%- include Backlinks.html -%}
|
data/assets/.DS_Store
CHANGED
|
Binary file
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: domain-jekyll
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.0.
|
|
4
|
+
version: 1.0.4
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Lumunix
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2022-
|
|
11
|
+
date: 2022-08-07 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: webrick
|
|
@@ -390,7 +390,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
390
390
|
- !ruby/object:Gem::Version
|
|
391
391
|
version: '0'
|
|
392
392
|
requirements: []
|
|
393
|
-
rubygems_version: 3.
|
|
393
|
+
rubygems_version: 3.3.7
|
|
394
394
|
signing_key:
|
|
395
395
|
specification_version: 4
|
|
396
396
|
summary: Jekyll theme for building a personal knowledge repository and blog.
|