https://github.com/matmoore/obsidian-static-site
Generate a website from a directory containing markdown notes
https://github.com/matmoore/obsidian-static-site
Last synced: about 1 year ago
JSON representation
Generate a website from a directory containing markdown notes
- Host: GitHub
- URL: https://github.com/matmoore/obsidian-static-site
- Owner: MatMoore
- Created: 2023-07-23T10:27:55.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-12T17:54:13.000Z (over 1 year ago)
- Last Synced: 2025-02-08T12:47:07.493Z (over 1 year ago)
- Language: CSS
- Size: 939 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Obsidian static site generator
**This is currently a work in progress and is not ready to be used by anyone else. If you are interested in collaborating, please raise an issue.**
## Purpose
This is a limited static site generator that generates a website from a directory containing markdown notes (e.g. a vault created by [Obsidian](https://obsidian.md/)).
## Why not use an existing static site framework?
I find static site frameworks tend to have a steep learning curve, and come with a lot of features I don't need. For this project I found it more interesting to just roll my own than spend time wrestling with a 3rd party framework.
I also want my site to generate quickly, so it's useful to have full control over the generation process.
## Why not pay for Obsidian Publish?
I think the pricing is quite expensive for what you get, and I'd rather not rely on subscription software that I could lose access to at short notice.
## Obsidian parser gem
The code for parsing the contents of the vault is available as a gem, [obsidian-parser](https://github.com/MatMoore/obsidian-parser).
## Local development
- Clone this repo
- Clone `obsidian-parser`
- In this repo:
- `gem install bundler`
- `bundle config set local.obsidian_parser ../obsidian-parser`
- `bundle install`
## Usage
- `bundle exec generator.rb`
## Licence
MIT