obsidian-ssg/README.md

1.5 KiB

This is a highly opinionated (read: entirely based on my config and not super flexible yet) WIP way to turn an obsidian vault into a static site. It also generates a couple (mostly) compliant atom feeds, and more will be improved in the future. This is written in fish cause it's the shell I use and I don't want to use full programming languages atm if I can avoid it. It could probably be improved and any feedback is welcome.

If you want to see my website's code you can find it here and my wiki can be found here

requires

how to use

create an obsidian vault and add some notes to it, a sample note is provided.

move obsidian-ssg.fish to your config

git clone 'https://git.merveilles.town/proto/obsidian-ssg'
cd obsidian-ssg
cp obsidian-ssg.fish ~/.config/fish/functions/obsidian-ssg.fish

run with the arguments

obsidian-ssg /path/to/wiki /path/to/website /path/to/pandoc_template.html

optional

I also have my config for obsidian-linter provided so copy that to /path/to/wiki/.obsidian/plugins/obsidian-linter/data.json and lint all files in the vault in order to ensure all markdown is formatted correctly