Jekyll Garden v 0.3 (Stable)
This is a simple Jekyll theme created for building a digital garden with Obsidian and Github Pages. You have to fork this theme to your Github account, configure Github pages, and start using the
_notes folder as the Obsidian vault. Check out the demo.
Installation (Github pages)
Detailed Installation how-to, with screenshots available here
Building a Jekyll website on Github Page is simple and seamless.
- Step 1: Sign-In to Github, visit the theme page and click on ‘Use this Template’
- Step 2: Name the forked repo as
- Step 3: Go to your repo’s settings > pages and set the source to your main branch.
- Step 4 (Optional): If you have a custom domain, set CNAME.
Claps! The Jekyll website with a Note Garden theme is ready. Visit
yourusername.github.io to see that.
If it’s not working, edit this readme (add something and commit) to trigger static page generation.
Part 2, setting Github Repo with Obsidian.
- Step 1: Go to
yourusername.github.io, and clone your repository to your machine. For this, you can use git-commands or install Github for desktop.
- Step 2: Once you have successfully cloned the repository to your machine, Open the Obsidian app, and set the folder
_notesinside the repository as your vault.
- Step 3: You can start adding notes to this vault and add frontmatter to support. Read about YAML at
Welcome to the garden.
- Step 4: Once you have enough notes, got to the Github Desktop app, commit the changes to main, and push the changes to Github. Github will update the pages!
Credits & Thanks
- rgvr, who created Simply Jekyll theme. This theme is a fork of Simply Jekyll and 90% code is by Raghu.
- Asim K T, who coded the base HTML.
- Santosh Thottingal, Binny V A, Puttalu who introduced me to Digital Garden, Zettelkasten, Org Mode etc. 🙂
- Team Obsidian for making obsidian a markdown based product
- Dark Mode Switch by Derek Kedziora – Source link
To set up your environment to develop this theme, run
bundle install after cloning this repository in your local machine.
Your theme is set up just like a normal Jekyll site! To test your theme, run
bundle exec jekyll serve and open your browser at
http://localhost:4000. This starts a Jekyll server using your theme.
_notes contain all atomic notes. If you want to use this for blog, add posts inside
_posts folder, following standard Jekyll frontamtter.
The theme is available as open source under the terms of the MIT License.