Free Obisidian Publish alternative, for publishing your digital garden.
Go to file
Triston 4f67dc7605 change title in settings file
not really sure what this does but why not
2024-02-17 12:10:03 -06:00
components remove comments 2024-02-17 11:54:32 -06:00
lib (debugging) nested links not working properly 2024-02-03 23:09:41 -06:00
notes@47ece2f311 no idea whats done in this commit 2023-12-24 08:16:52 -06:00
pages remove pages associated with portfolio 2024-02-17 12:09:11 -06:00
public Add alien instead of my face 2024-01-11 17:47:28 -06:00
styles Update the thai page 2024-02-13 21:29:08 -06:00
.eslintrc.cjs remove no unused var as being error 2024-01-07 13:58:15 -06:00
.gitignore update gitignore to ignore posts dir 2023-12-23 21:14:44 -06:00
.gitmodules replace personal notes dir with obsidian start vault 2024-02-17 12:09:26 -06:00
bun.lockb remove unused mui packages 2024-01-08 22:34:04 -06:00
LICENSE Create LICENSE 2022-04-20 08:11:07 +07:00
netlify.toml change plubish dir to out 2024-01-07 12:52:39 -06:00
next-env.d.ts debugging making app work again 2023-12-31 09:35:22 -06:00
next.config.js convert img tags to Image components in index file 2024-01-08 22:33:54 -06:00
package.json remove unused mui packages 2024-01-08 22:34:04 -06:00
README.md begin rewording readme 2024-02-17 12:09:50 -06:00
settings.json change title in settings file 2024-02-17 12:10:03 -06:00
tsconfig.json mask some build errors and make some config changes 2024-01-07 01:50:56 -06:00

What is XeNote?

XeNote is a free open-source alternative solution to Obsidian Publish

Here's how it looks once published, checkout demo here: demo

This website includes a published version of default Obsidian Help vault, See it in action here

MindStone features:

  • Drop-in support for (default) Obsidian Vault
  • [[Wiki Link]] built-in support
  • Folder-base navigation side bar
  • Backlink support out of the box
  • Interactive Graph view
  • Easy to deploy to Netlify, Vercel...

Getting started

Run on your local machine

Steps to run it on your local machine:

  1. Clone this Github repo
  2. Install yarn package manager
  3. Copy all of your markdown file (.md only) and folder to /posts/ except /posts/index.md file
  4. Copy all of your images from your Obsidian Vault to /public/images/ folder
  5. Go to root folder of your project, run yarn && yarn run dev
  6. Open this link in your browser http://localhost:3000/

If you prefer video content have a look at my 📺 walk through video

Publish to the internet

Setup environment (with Netlify)

  1. Create your Github account and clone my repository
  2. Create Netlify account and follow this instruction

Your normal workflow for publishing content, after initial setup is:

  1. Simply writing your content in Obisidian (or your favourite Markdown editor)
  2. Commit your changes and Push it to your Github repo

If you prefer video content, watch my 📺 walk through video here

Future development

These are just some basic features for MindStone v1, many more are coming (if I find enough of interest and this will probably a premium/paid option):

  • 🎯Obsidian, Notion, VSCode Plugin
  • 🎯Page Preview (like Obsidian Core plugin)
  • 🎯Andy Sliding pane
  • 🎯Full text search with Cmd + K
  • 🎯Infinite canvas for browsing through notes and connections

Some know issues

This an early version of MindStone, which mean there are bugs and issues. Below are some known issues, that I plan to work on:

  • Graphview does not load when clicking on side-bar or click node on graphview, browser reload will refresh it state
  • Graph view layout and interaction is still very rough. More UI/UX improvements are needed.
  • Transclusion is not working yet.