You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+34-6
Original file line number
Diff line number
Diff line change
@@ -10,6 +10,8 @@ Dark Poole is a permanent dark theme of the Poole theme by [@mdo](https://github
10
10
11
11
That's it! I tried to be least intrusive as possible to the Poole code base.
12
12
13
+
**I noticed that Poole's documentation is slightly outdated and misleading. This documentation will try to address most, if not all, of these issues.**
14
+
13
15
---
14
16
15
17
## Contents
@@ -42,7 +44,7 @@ $ gem install bundler
42
44
43
45
### 3. Running locally
44
46
45
-
To see your Jekyll site with Poole applied, start a Jekyll server. In Terminal, from `/poole` (or whatever your Jekyll site's root directory is named):
47
+
To see your Jekyll site with Poole applied, start a Jekyll server. In Terminal, from `/dark-poole` (or whatever your Jekyll site's root directory is named):
46
48
47
49
```bash
48
50
$ bundle exec jekyll serve
@@ -56,17 +58,46 @@ If you host your code on GitHub, you can use [GitHub Pages](https://pages.github
56
58
57
59
1. Fork this repo and switch to the `gh-pages` branch.
58
60
1. If you're [using a custom domain name](https://help.github.com/articles/setting-up-a-custom-domain-with-github-pages), modify the `CNAME` file to point to your new domain.
59
-
1. If you're not using a custom domain name, **modify the `baseurl` in `_config.yml`** to point to your GitHub Pages URL. Example: for a repo at `github.com/username/poole`, use `http://username.github.io/poole/`. **Be sure to include the trailing slash.**
61
+
1. If you're not using a custom domain name, **modify the `url` in `_config.yml`** to point to your GitHub Pages URL. Example: for a site hosted at `username.github.io`, use `http://username.github.io`.
62
+
1. If you want to use your repo name as a base url, **set the `url`** to your repo link and **set the `baseurl`** to your repo name in **`_config.yml`**. Example: for site hosted on `https://username.github.io/dark-poole`, set `url` as `https://username.github.io/dark-poole` and `baseurl` as `/dark-poole`.
60
63
1. Done! Head to your GitHub Pages URL or custom domain.
61
64
62
65
No matter your production or hosting setup, be sure to verify the `baseurl` option file and `CNAME` settings. Not applying this correctly can mean broken styles on your site.
63
66
67
+
### 5. Pagination for sites with base urls
68
+
69
+
If you are using a base url for your site, (for example, hosted on `https://username.github.io/dark-poole`) you have to make some changes to get jekyll-pagination to work correctly:
70
+
71
+
In `_config.yml`, add this line:
72
+
73
+
```yaml
74
+
paginate_path: "/baseurl/page:num/"
75
+
```
76
+
77
+
In `archive.md`, add `{{ site.baseurl }}` before `{{ post.url }}`
Poole has two branches, but only one is used for active development.
67
98
68
99
- `master`for development. **All pull requests should be to submitted against `master`.**
69
-
-`gh-pages` for our hosted site, which includes our analytics tracking code.**Please avoid using this branch.**
100
+
- `gh-pages`for hosted demo **Please avoid using this branch.**
70
101
71
102
CSS is handled via Jeykll's built-in Sass compiler. Source Sass files are located in `_sass/`, included into `styles.scss`, and compile to `styles.css`.
0 commit comments