jekyll-obsidian

jekyll-obsidian

View Obsidian vaults, on your Jekyll website.

jekyll-obsidian is designed to emulate as much of Obsidian's original look and feel, allowing your Obsidian vaults to be hosted on a static Jekyll site.

It should work out of the box if you use the default minima theme. Otherwise, you can modify the generated obsidian.scss and its partials. These .scss files are not overwritten when the site is served, and if you want to reset the styles, simply delete that modified .scss file and the gem will regenerate the default one.

Thank you to the developers of DOMPurify, js-cookie (for saving color scheme), markdown-it (for parsing .md notes), and two.js (for drawing .canvas node edges).

Features

This Jekyll plugin has all the core features of Obsidian, including:

• Backlinks
• Embeds
• Callouts
• Linked mentions
• Canvas
• File search
• Color schemes
• Mobile support

Some creative liberties were taken. For example, clicking on an image file will open a modal displaying it instead.

Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add jekyll-obsidian

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install jekyll-obsidian

Setup

• Add the following to your site's _config.yml:

  plugins:
      - jekyll-obsidian
  

• Drop your Obsidian vault folder into your site, make sure to remove the .git folder and .gitignore file

• Create a .markdown front matter file using the generated layout

  ---
  layout: obsidian
  title: Your Obsidian Vault
  permalink: /your-obsidian-vault/
  sitemap: false
  ---
  

• Add gem 'jekyll-obsidian' into your site's Gemfile, preferably within group :jekyll_plugins

  group :jekyll_plugins do
  gem 'jekyll-obsidian'
  end
  

• In your _config.yml, set obsidian_vault to the root of the Obsidian vault

  obsidian_vault: "Your Obsidian Vault"
  obsidian_vault: "vaults/Another Obsidian Vault"
  

• Run bundle install or bundle update jekyll-obsidian, if you already installed it

• Run bundle exec jekyll build to generate the necessary .css and .json files.

• 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"

obsidian_backlinks Enables or disables backlinks, defaults to true

obsidian_backlinks: false

obsidian_embeds Enables or disables embeds, defaults to true

obsidian_embeds: false

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/khiemgluong/jekyll-obsidian. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the jekyll-obsidian project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.