Skip to content

johackim/obsidian-publish

Repository files navigation

Obsidian Publish

A self-hosted alternative to Obsidian Publish with additional features.

🧐 Why?

Obsidian Publish is awesome, but you can't customize SEO, robots.txt, rss.xml & sitemap.xml.

So, I created this project to self-host my Obsidian Publish vault with theses features.

✨ Features

  • Robots.txt
  • Sitemap
  • Mermaid
  • Page 404
  • Navigation
  • Redirects
  • Dark mode
  • Responsive
  • RSS feed
  • Favicon
  • SEO
  • Analytics
  • Embed web pages
  • Table of contents
  • Search bar
  • Backlinks
  • Callouts
  • Graph viewer
  • Hover preview

📦 Usage

Install the dependencies:

yarn install

Setup the environment variables:

cp .env.dist .env

Run the development server:

npm run dev

🎁 Support me

I'd love to work on this project, but my time on this earth is limited, support my work to give me more time!

Please support me with a one-time or a monthly donation and help me continue my activities.

Github sponsor ko-fi Buy me a coffee liberapay Github Mastodon Twitter

📜 License

This project is licensed under the GNU GPL v3.0 - see the LICENSE.txt file for details

Free Software, Hell Yeah!

About

A self-hosted alternative to Obsidian Publish with additional features.

Topics

Resources

License

Stars

Watchers

Forks