From 316f037df8ef90e3d3b4a17b77d6ce4831bc37af Mon Sep 17 00:00:00 2001 From: rzen Date: Mon, 22 Jul 2019 23:56:43 -0400 Subject: [PATCH] instructions on using private notes --- _blog/README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/_blog/README.md b/_blog/README.md index 60510e0..714f4fd 100644 --- a/_blog/README.md +++ b/_blog/README.md @@ -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. -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 @@ -48,7 +50,7 @@ Fundamentally setting up a jekyll website with a theme is a straightforward proc `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). -`private.html` +`private.html` : 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` @@ -202,7 +204,6 @@ To develop and test simply run from the root of a cloned `jekyll-theme-isabellin $ docker-compose up jekyll-serve ``` - ## License The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). \ No newline at end of file