Free Obisidian Publish alternative, for publishing your digital garden.
Go to file
2023-12-31 15:25:23 -06:00
components export link type interface 2023-12-31 15:17:04 -06:00
lib make router nav to correct directory 2023-12-31 11:56:14 -06:00
notes@47ece2f311 no idea whats done in this commit 2023-12-24 08:16:52 -06:00
pages add link type to homeprops 2023-12-31 15:25:23 -06:00
public remove a bunch of public bloat and scripts files 2023-12-25 19:25:35 -06:00
styles add flex style to navbar 2023-12-31 15:17:15 -06:00
.eslintrc.cjs add eslint to project 2023-12-30 10:42:21 -06:00
.gitignore update gitignore to ignore posts dir 2023-12-23 21:14:44 -06:00
.gitmodules add my notes as a submodule 2023-12-23 21:27:04 -06:00
bun.lockb fix bug preventing home notes from rendering 2023-12-31 10:57:12 -06:00
LICENSE Create LICENSE 2022-04-20 08:11:07 +07:00
next-env.d.ts debugging making app work again 2023-12-31 09:35:22 -06:00
next.config.js debugging making app work again 2023-12-31 09:35:22 -06:00
package.json fix bug preventing home notes from rendering 2023-12-31 10:57:12 -06:00
postcss.config.cjs debugging making app work again 2023-12-31 09:35:22 -06:00
README.md Update Readme 2022-05-17 07:35:39 +07:00
settings.json ... 2020-11-30 14:29:34 +03:00
tailwind.config.js add eslint to project 2023-12-30 10:42:21 -06:00
tsconfig.json update tsconfig 2023-12-31 09:35:37 -06:00

What is MindStone?

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

Here how it look like once published, checkout demo version here:

This website include 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.