README.md in jekyll-obsidian-1.1.1 vs README.md in jekyll-obsidian-1.1.2
- old
+ new
@@ -38,18 +38,17 @@
1. Add the following to your site's `_config.yml`:
```yml
plugins:
- jekyll-obsidian
```
-2. Drop your Obsidian vault folder into your site
+2. Drop your Obsidian vault folder into your site, make sure to remove the .git folder and .gitignore file
3. Create a .markdown front matter file using the generated layout
```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
@@ -62,19 +61,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.
- > This will rename all your obsidian .md files to .mdnote, so Jekyll doesn't convert it to an html page
+7. Run `bundle exec jekyll build` to generate the necessary `.css` and `.json` files, and convert all your `.md` notes to `.mdnote`.
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.md"
+obsidian_homepage: "homepage.mdnote"
obsidian_homepage: "homecanvas.canvas"
```
`obsidian_backlinks`
Enables or disables backlinks, defaults to true