Overview
Obsidian 2 Jekyll is a simple python script that converts Obsidian notes to a format compatible with Jekyll themes that support wikilinks and backlinking, such as Jekyll Garden or Digital Garden Jekyll Template. This script allows users to add the filename as a title in the frontmatter and control the visibility of their notes either on a folder or note-by-note basis.
Features
- Converts Obsidian notes to theme-compatible markdown for Jekyll
- Adds filename as a title in the frontmatter
- Allows users to set the visibility of their notes as public or private
- Inherits folder visibility if note visibility is not defined
- Supports jenkyll themes that support wikilinks
Installation
To use Obsidian 2 Jekyll, you need to have Python3 installed on your system. Once you have Python3 installed, follow these instructions:
- Clone the
obsidian-to-jekyllrepository. - Navigate to the cloned repository in your command line/terminal.
- Run the
obsidian-to-jekyll.pyscript.
git clone <repository-url>
cd obsidian-to-jekyll
python3 obsidian-to-jekyll.py
Summary
Obsidian 2 Jekyll is a python script that converts Obsidian notes to a format compatible with Jekyll themes that support wikilinks. It adds the filename as a title in the frontmatter and allows users to control the visibility of their notes. This script is part of a larger Obsidian publish setup created by Adrian Steffan.