Skip to content

Commit 5de1e42

Browse files
author
Sumit Khanna
committed
Formatting updates
1 parent c2c567c commit 5de1e42

File tree

1 file changed

+48
-53
lines changed

1 file changed

+48
-53
lines changed

README.md

Lines changed: 48 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -27,59 +27,54 @@ To install from source:
2727
Usage
2828
-----
2929

30-
In your `_config.yml`, add the following section:
31-
32-
...
33-
gems:
34-
- jekyll-multisite
35-
36-
shared: _shared
37-
shared_pagination: true
38-
...
39-
4030
Each individual site needs to have it's own configuration file with it's own source and destination. Let's use `_example_com.yml` to demonstrate:
4131

42-
...
43-
title: Example dot Com
44-
url: http://example.com
45-
destination: _site/example.com
46-
source: '_example.com'
47-
exclude: ['some-file.md']
48-
...
32+
```
33+
...
34+
title: Example dot Com
35+
url: http://example.com
36+
destination: _site/example.com
37+
source: '_example.com'
38+
exclude: ['some-file.md']
39+
...
40+
```
4941

5042
Now, lets' create a second site as well, in a file called `_example_net.yml`
5143

52-
...
53-
title: Example dot Net
54-
url: http://example.net
55-
destination: _site/example.net
56-
source: '_example.net'
57-
exclude: ['some-other-file.md']
58-
...
44+
```
45+
...
46+
title: Example dot Net
47+
url: http://example.net
48+
destination: _site/example.net
49+
source: '_example.net'
50+
exclude: ['some-other-file.md']
51+
...
52+
```
5953

6054
Finally, we need a base `_config.yml` that declares all the settings that are shared:
6155

62-
63-
baseurl: ""
64-
paginate: 10
65-
gems:
66-
- jekyll-multisite
67-
- jekyll-paginate
68-
69-
markdown: kramdown
70-
71-
layouts_dir: _layouts
72-
includes_dir: _includes
73-
plugins_dir: _plugins
74-
shared_dir: _shared
75-
shared_pagination: true
76-
77-
include: ['.htaccess']
78-
79-
sass:
80-
sass_dir: _sass
81-
style: compressed
82-
56+
```
57+
58+
baseurl: ""
59+
paginate: 10
60+
gems:
61+
- jekyll-multisite
62+
- jekyll-paginate
63+
64+
markdown: kramdown
65+
66+
layouts_dir: _layouts
67+
includes_dir: _includes
68+
plugins_dir: _plugins
69+
shared_dir: _shared
70+
shared_pagination: true
71+
72+
include: ['.htaccess']
73+
74+
sass:
75+
sass_dir: _sass
76+
style: compressed
77+
```
8378

8479
Due to the way things are done internally in Jekyll and the limitation of my plugin, the shared source directory must be one directory down from the source path. Your directory structure should look like the following:
8580

@@ -131,11 +126,11 @@ Take care to notice you still need a symbolic link for `_plugins` to work correc
131126

132127
Things to note:
133128

134-
# Due to a bug, you still need to symbolic link `_plugins` from your base to the site source
135-
# Watching and dynamic updating of changed to the `_shared` directory doesn't currently work
136-
# `_shared` must be one directory below (../) the source for each website.
137-
# If you have something in both the site source and the shared source, the shared will overwrite what is in the site source
138-
# I had to monkey patch the pagination plugin to work with this setup. You may have to adjust other plugins for multi-site support
139-
# The shared output is actually generated in `_site` and moved after generation is complete
140-
# This entire plugin is very hacky and does some interesting stuff under the hood to get multi-site working.
141-
# Only tested on Jekyll 3.0.1. Other versions will most likely not work.
129+
* Due to a bug, you still need to symbolic link `_plugins` from your base to the site source
130+
* Watching and dynamic updating of changed to the `_shared` directory doesn't currently work
131+
* `_shared` must be one directory below (../) the source for each website.
132+
* If you have something in both the site source and the shared source, the shared will overwrite what is in the site source
133+
* I had to monkey patch the pagination plugin to work with this setup. You may have to adjust other plugins for multi-site support
134+
* The shared output is actually generated in `_site` and moved after generation is complete
135+
* This entire plugin is very hacky and does some interesting stuff under the hood to get multi-site working.
136+
* Only tested on Jekyll 3.0.1. Other versions will most likely not work.

0 commit comments

Comments
 (0)