README.md in jekyll-obsidian-1.1.8 vs README.md in jekyll-obsidian-1.2.0
- old
+ new
@@ -45,10 +45,11 @@
```yml
---
layout: obsidian
title: Your Obsidian Vault
permalink: /your-obsidian-vault/
+ sitemap: false
---
```
4. Add `gem 'jekyll-obsidian'` into your site's Gemfile, preferably within `group :jekyll_plugins`
```ruby
group :jekyll_plugins do
@@ -61,18 +62,18 @@
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 build` to generate the necessary `.css` and `.json` files, and convert all your `.md` notes to `.mdj`.
+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
-obsidian_homepage: "homepage.mdnote"
+obsidian_homepage: "homepage.md"
obsidian_homepage: "homecanvas.canvas"
```
`obsidian_backlinks`
Enables or disables backlinks, defaults to true