README.md in jekyll-obsidian-1.0.4 vs README.md in jekyll-obsidian-1.0.5
- old
+ new
@@ -49,21 +49,33 @@
title: Your Obsidian Vault
permalink: /your-obsidian-vault/
sitemap: false
---
```
-5. In your `_config.yml`, set `obsidian_vault` to the root of the Obsidian vault
- > obsidian_vault: "Your Obsidian Vault"
+5. Add `gem 'jekyll-obsidian'` into your site's Gemfile, preferably within `group :jekyll_plugins`
+ ```ruby
+ group :jekyll_plugins do
+ gem 'jekyll-obsidian'
+ end
+ ```
- > obsidian_vault: "vaults/Another Obsidian Vault"
-6. Run `bundle exec jekyll serve`, you should now see your Obsidian page at your given permalink
+6. 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"
+ ```
+7. Also in `_config.yml`, set the `exclude` to that obsidian vault
+
+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
-> obsidian_homepage: "homepage.md"
-
-> obsidian_homepage: "homecanvas.canvas"
+```ruby
+obsidian_homepage: "homepage.md"
+obsidian_homepage: "homecanvas.canvas"
+```
`obsidian_backlinks`
Enables or disables backlinks, defaults to true
> obsidian_backlinks: false