README.md in jekyll-obsidian-1.0.10 vs README.md in jekyll-obsidian-1.1.0
- old
+ new
@@ -32,40 +32,42 @@
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install jekyll-obsidian
## Setup
-1. First run `bundle exec jekyll build` to generate the necessary .css files for the _sass/obsidan partials.
-2. Add the following to your site's `_config.yml`:
+1. Add the following to your site's `_config.yml`:
```yml
plugins:
- jekyll-obsidian
```
-3. Drop your Obsidian vault folder into your site
-4. Create a .markdown front matter file using the generated layout
+2. Drop your Obsidian vault folder into your site
+3. Create a .markdown front matter file using the generated layout
```yml
---
layout: obsidian
title: Your Obsidian Vault
permalink: /your-obsidian-vault/
sitemap: false
---
```
-5. Add `gem 'jekyll-obsidian'` into your site's Gemfile, preferably within `group :jekyll_plugins`
+4. Add `gem 'jekyll-obsidian'` into your site's Gemfile, preferably within `group :jekyll_plugins`
```ruby
group :jekyll_plugins do
gem 'jekyll-obsidian'
end
```
-6. In your `_config.yml`, set `obsidian_vault` to the root of the Obsidian vault
+5. In your `_config.yml`, set `obsidian_vault` to the root of the Obsidian vault
```ruby
obsidian_vault: "Your Obsidian Vault"
obsidian_vault: "vaults/Another Obsidian Vault"
```
+6. Run `bundle install` or `bundle update jekyll-obsidian`, if you already installed it
-7. Run `bundle exec jekyll serve`, you should now see your Obsidian page at your given permalink
+7. Run `bundle exec jekyll build` to generate the necessary `.css` and `.json` files.
+
+8. Run `bundle exec jekyll serve`, you should now see your Obsidian page at your given permalink
## Options
`obsidian_homepage`
Sets the homepage for your obsidian vault
```ruby