How to publish:
Open the obsidian project, make the changes you want.
Be sure to add any new pages to the build settings for the Export Vault to HTML plugin
If you press the hotkey, it will prompt you.
on Mac:
Press command-\ and then command-]
on Windows:
Press ctrl-\ and then ctrl-]
This will trigger Export Vault to HTML using the previous settings and git commit and sync.
if you are switching computers, you'll need to change the publishing folder.
For example,
C:\\Users\username\iCloudDrive\iCloud~md~obsidian\n2-n\public
will need to be changed to:
/Users/username/Library/Mobile Documents/iCloud~md~obsidian/Documents/n2-n/public
when I move back to my laptop.
Stack:
This project is setup to work with the following tech stack
Obsidian - markdown note taking app
Obsidian community plugin git - version control
GitHub - repo hosting
Obsidian community plugin Export Vault to HTML - web ready files
Cloudflare - serverless hosting and domain services
Each part of this stack can be learned one step at a time and there is plenty to learn about the concepts behind each tool if you are seeking a deeper understanding. But I'll aim to onboard someone that might not want to know everything, but get the result: a serverless site that is controlled through Obsidian.
The stack focuses on the use of free tools like Obsidian which has community plugins to further help us, git, GitHub and Cloudflare.
If you would like a custom domain that will have a cost. If you have LOTS of traffic, this can end up having a cost. But I assure you, this is very frugal and should be free for 99.9% of use cases as far as I can tell. If you don't need a custom domain and have less than, idk at least 10,000 unique visitors I think this will be 100% free. I'm not sure about limits but I'll update when I know. (cloudflare workers free tier supports 100,000 requests but I'm unsure what triggers a request as of writing)
If I'm not mistaken, setup will be the hardest part aside from creating content. If you are interested in learning this and can't figure it out from my musings here, reach out to me.
This is the old readme, it will need updated.
The site cannot build itself from markdown changes alone (yet, perhaps if I tinker more).
You need to build the html in obsidian and then commit and push via git.
I'll see if I can't get update/sync the way I want it.
These changes were made via GitHub's editor to test.
If everything works, I should just be able to edit this, build for html and see the changes. If I didn't have to run the build each time that would be dreamy. It will take a moment to propagate all the way to the website.
home
created: 2025-05-31