Jekyll Themes & Templates Logo Jekyll Themes & Templates
Jekyll Garden.github.io screenshot

Jekyll Garden.github.io

Author Avatar Theme by Jekyll garden
Updated: 5 Jan 2024
394 Stars

A Digital Garden Theme for Jekyll. Jekyll Garden lets you create a static HTML version of your markdown notes and publish via Github pages. Made for Obsidian users!

Github Live Preview

Categories

Digital garden

Overview

Jekyll Garden v 0.4 is a theme that allows you to publish your Obsidian vault or a subset of it as a Jekyll static website. It is designed to be markdown and Obsidian setup friendly, and you can choose to use your own server or Github page for hosting.

Features

  • Demo Website: Check out the demo to see how the Jekyll Garden theme looks and functions.
  • Personal Website: Use this theme to create your own personal website and showcase your work.
  • Markdown and Obsidian Setup Friendly: The theme is designed to work seamlessly with markdown and Obsidian, making it easy to publish your content.
  • Easy Installation: Set up your environment to develop this theme by running bundle install after cloning the repository.
  • Jekyll Server: Test your theme by running bundle exec jekyll serve and opening your browser at http://localhost:4000.
  • Containerized Hosting: You can also choose to host the theme on a docker container using Docker and Docker-compose.
  • MIT License: The Jekyll Garden theme is available as open source under the terms of the MIT License.

Installation

To install Jekyll Garden v 0.4, follow these steps:

  1. Clone the repository to your local machine.
  2. Run bundle install to set up your development environment.
  3. Test the theme by running bundle exec jekyll serve and open your browser at http://localhost:4000.

If you choose to host the theme in a Docker container:

  1. Install Docker and Docker-compose.
  2. Run the docker-compose command to start the container.
  3. Make sure to map any frequently modified directories as local volumes in the docker-compose.yml file.

Summary

Jekyll Garden v 0.4 is a versatile theme that allows you to publish your Obsidian vault as a Jekyll static website. It offers features such as easy installation, support for markdown and Obsidian, and the option to host the theme in a Docker container. With its user-friendly design and open source nature, Jekyll Garden is a great choice for creating your own personal website or blog.