Skip to content

Commit 4d2ab22

Browse files
author
Andrew Park
committed
Updated README
1 parent 1f3200a commit 4d2ab22

File tree

1 file changed

+34
-6
lines changed

1 file changed

+34
-6
lines changed

README.md

+34-6
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ Dark Poole is a permanent dark theme of the Poole theme by [@mdo](https://github
1010

1111
That's it! I tried to be least intrusive as possible to the Poole code base.
1212

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+
1315
---
1416

1517
## Contents
@@ -42,7 +44,7 @@ $ gem install bundler
4244

4345
### 3. Running locally
4446

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):
4648

4749
```bash
4850
$ bundle exec jekyll serve
@@ -56,17 +58,46 @@ If you host your code on GitHub, you can use [GitHub Pages](https://pages.github
5658

5759
1. Fork this repo and switch to the `gh-pages` branch.
5860
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`.
6063
1. Done! Head to your GitHub Pages URL or custom domain.
6164

6265
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.
6366

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 }}`
78+
79+
```html
80+
<!-- Add "{{ site.baseurl }}" -->
81+
<li><a href="{{ site.baseurl }}{{ post.url }}">{{ post.title }}</a></li>
82+
```
83+
84+
In `index.html`, remove the `prepend:`:
85+
86+
```html
87+
<!-- Remove "prepend:" in "prepend: relative_url" -->
88+
<a
89+
class="pagination-item newer"
90+
href="{{ paginator.previous_page_path | relative_url }}"
91+
>Newer</a
92+
>
93+
```
94+
6495
## Development
6596

6697
Poole has two branches, but only one is used for active development.
6798

6899
- `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.**
70101

71102
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`.
72103

@@ -81,9 +112,6 @@ nav:
81112
82113
- title: About
83114
url: /about
84-
85-
- title: Feed
86-
url: /atom.xml
87115
```
88116

89117
## Author

0 commit comments

Comments
 (0)