Skip to content

Commit c2b187c

Browse files
author
Sumit Khanna
committed
Documentation fixes
1 parent 587cf40 commit c2b187c

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ jekyll-multisite
33

44
[![Gem](https://img.shields.io/gem/v/jekyll-multisite.svg?style=plastic)]()
55

6-
Jekyll doesn't support multiple sites by default. If you want to have multiple sites with shared source code with Jekyll, you'll need to use the [jekyll-unsanitize](https://github.com/sumdog/jekyll-unsanitize) gem plus a ton of ugly symbolic links in your source tree. The following plugin adds support for a sahred base that can be used in multiple Jekyll projects.
6+
Jekyll doesn't support multiple sites by default. If you want to have multiple sites with shared source code with Jekyll, you'll need to use the [jekyll-unsanitize](https://github.com/sumdog/jekyll-unsanitize) gem plus a ton of ugly symbolic links in your source tree. The following plugin adds support for a shared base that can be used in multiple Jekyll projects.
77

88
Dependencies
99
--------
1010

11-
* jekyll v3.0.1+
11+
* jekyll v3.0.1
1212

1313
Installation
1414
------------
@@ -76,7 +76,7 @@ sass:
7676
style: compressed
7777
```
7878

79-
**Please note the `_plugins` directory must be a list and not a strong** [See Issue #4261](https://github.com/jekyll/jekyll/issues/4261)
79+
**Please note the `_plugins` directory must be a list and not a string** [See Issue #4261](https://github.com/jekyll/jekyll/issues/4261)
8080

8181
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:
8282

@@ -130,7 +130,7 @@ Things to note:
130130
* Watching and dynamic updating of changed to the `_shared` directory doesn't currently work
131131
* `_shared` must be one directory below (../) the source for each website.
132132
* 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
133+
* I had to monkey patch the pagination plugin to work with this setup. This gem auto-detects if you have jekyll-pagination and applies the patch if needed. You may have to adjust other plugins for multi-site support
134134
* The shared output is actually generated in `_site` and moved after generation is complete
135135
* 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.
136+
* Only tested on Jekyll 3.0.1. Other versions will most likely not work.

0 commit comments

Comments
 (0)