Skip to content

Commit 587cf40

Browse files
author
Sumit Khanna
committed
Documentation update for plugins
1 parent 8f7a85e commit 587cf40

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,8 @@ markdown: kramdown
6565
6666
layouts_dir: _layouts
6767
includes_dir: _includes
68-
plugins_dir: _plugins
68+
plugins_dir:
69+
- _plugins
6970
shared_dir: _shared
7071
7172
include: ['.htaccess']
@@ -75,6 +76,8 @@ sass:
7576
style: compressed
7677
```
7778

79+
**Please note the `_plugins` directory must be a list and not a strong** [See Issue #4261](https://github.com/jekyll/jekyll/issues/4261)
80+
7881
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:
7982

8083
```
@@ -88,7 +91,6 @@ Due to the way things are done internally in Jekyll and the limitation of my plu
8891
│   ├── favicon.ico
8992
│   ├── files
9093
│   ├── images
91-
│   ├── _plugins -> ../_plugins/
9294
│   ├── _posts
9395
│   └── videos.html
9496
├── _example_com.yml
@@ -100,7 +102,6 @@ Due to the way things are done internally in Jekyll and the limitation of my plu
100102
│   ├── favicon.ico
101103
│   ├── files
102104
│   ├── images
103-
│   ├── _plugins -> ../_plugins/
104105
│   ├── _posts
105106
│   └── videos.html
106107
├── _example_net.yml
@@ -118,14 +119,14 @@ Due to the way things are done internally in Jekyll and the limitation of my plu
118119
└── _plugins
119120
```
120121

121-
Take care to notice you still need a symbolic link for `_plugins` to work correctly (I'm working on fixing that). When you build you sites, built them like so:
122+
When you build you sites, built them like so:
122123

123124
jekyll build --config _config.yml,_example_net.yml
124125
jekyll build --config _config.yml,_example_com.yml
125126

126127
Things to note:
127128

128-
* Due to a bug, you still need to symbolic link `_plugins` from your base to the site source
129+
* `_plugins` must be a list. Since the `plugin_manager.rb` is loaded first to load this plugin, there is no way to monkey-patch in a fix for this.
129130
* Watching and dynamic updating of changed to the `_shared` directory doesn't currently work
130131
* `_shared` must be one directory below (../) the source for each website.
131132
* If you have something in both the site source and the shared source, the shared will overwrite what is in the site source

0 commit comments

Comments
 (0)