tristonarmstrong/XeNote
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Free Obisidian Publish alternative, for publishing your digital garden.
139 Commits 1 Branch 0 Tags 43 MiB
JavaScript 62.8%
TypeScript 19.8%
CSS 17.4%
c31428d8e4
Go to file
Triston Armstrong c31428d8e4 fix a few utils bugs 
- unified import no longer default import
- make index file a variable but also be my actual entry file for my notes
- create some variables to make reading easier
- cleanup the file/directory replacement characters (what like "++++" which is ridiculous)
- lots of formatting changes
2023-12-23 20:16:56 -06:00
components improve mdcontent component 2023-12-23 20:10:03 -06:00
lib fix a few utils bugs 2023-12-23 20:16:56 -06:00
pages Update tracking to mindstone.tuancao.me 2022-05-26 11:29:36 +07:00
posts delete starter posts 2023-12-23 20:06:26 -06:00
public Update README and index.m content 2022-04-20 09:35:44 +07:00
styles Revert "Update image styling" 2022-04-20 00:15:23 +07:00
.gitignore GitIgnore vscode and yarn 2022-04-19 22:50:27 +07:00
bun.lockb upgrade all packages to latest and convert to using bun 2023-12-23 20:04:46 -06:00
LICENSE Create LICENSE 2022-04-20 08:11:07 +07:00
next.config.js upgrade all packages to latest and convert to using bun 2023-12-23 20:04:46 -06:00
package.json upgrade all packages to latest and convert to using bun 2023-12-23 20:04:46 -06:00
README.md Update Readme 2022-05-17 07:35:39 +07:00
settings.json ... 2020-11-30 14:29:34 +03:00
Test Linki.md Add obsidian help vault notes 2022-03-16 12:01:46 +07:00

README.md

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.