rzen/jekyll-theme-isabelline
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

instructions on using private notes

Browse Source
This commit is contained in:
rzen 2019-07-22 23:56:43 -04:00
parent 68ebe2c414
commit 316f037df8
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
_blog/README.md
View File

@ -22,7 +22,9 @@ Fundamentally setting up a jekyll website with a theme is a straightforward proc
4. Copy `isabelline`'s starter `_config.yaml` and customize it to your liking. 4. Copy `isabelline`'s starter `_config.yaml` and customize it to your liking.
5. Run bundle install. 5. Create the following folders for your future contents: `_blog`, `_drafts`, `_pages`, `_posts`, and `_private`. The latter is for private notes which will only be rendered in [local mode](#local-mode).
6. Run bundle install.
## Docker cookbook ## Docker cookbook
@ -48,7 +50,7 @@ Fundamentally setting up a jekyll website with a theme is a straightforward proc
`404.html` `404.html`
: A page that is shown when the target for a link isnt available. Here's an example of a [404 link](/broken-link). : A page that is shown when the target for a link isnt available. Here's an example of a [404 link](/broken-link).
`private.html` <a id="local-mode"></a>`private.html`
: Index file for private notes. These notes will only render in local mode. That is when `JEKYLL_ENV` is set to `local`. : Index file for private notes. These notes will only render in local mode. That is when `JEKYLL_ENV` is set to `local`.
`docker-compose.yaml` `docker-compose.yaml`
@ -202,7 +204,6 @@ To develop and test simply run from the root of a cloned `jekyll-theme-isabellin
$ docker-compose up jekyll-serve $ docker-compose up jekyll-serve
``` ```
## License ## License
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).