Update README and index.m content

README.md

@@ -1,6 +1,60 @@
-# Digital Garden with Next.JS
+## What is MindStone?
+MindStone is a free open-source alternative solution to [Obsidian Publish](https://obsidian.md/publish)
 
-Basic concept
+Here how it look like once published, checkout [demo version](https://mindstone.tuancao.me/) here:
-- Support Obsidian wiki link style, work out of the box with Obsidian Help Vault as a proof of concept
+
-- Sidebar navigation
+![](public/images/CleanShot%202022-04-20%20at%2008.34.17@2x.png)
-- 
+
+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](https://github.com/TuanManhCao/digital-garden)
+2. Install [yarn](https://classic.yarnpkg.com/lang/en/docs/install/#mac-stable) package manager 
+3. Copy all of your **markdown** file (`.md` only) and folder to `/posts/` **except** `/posts/index.md` file
+4. Go to root folder of your project, run `yarn && yarn run dev`
+5. Open this link in your browser http://localhost:3000/ 
+
+If you prefer video content have a look at my walk through video in here
+**Youtube**
+
+### Publish to the internet
+
+Setup environment (with Netlify)
+1. Create your Github account and clone [my repository](https://github.com/TuanManhCao/digital-garden)
+2. Create Netlify account and follow [this instruction](https://www.netlify.com/blog/2020/11/30/how-to-deploy-next.js-sites-to-netlify/) 
+
+
+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:
+- Image link in wiki link style is not supported yet. `![[Image_link.png]]` will not work yet.  see work around below
+- 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.

posts/Obsidian/Index.md

@@ -1,52 +0,0 @@
-## About this site
-Welcome to Obsidian's official help vault! This page contains a quick index to the things that you may be interested in.
-
-See public hosted version: https://publish.obsidian.md/help
-
-If you found mistakes or missing information, you can contribute to this site here: https://github.com/obsidianmd/obsidian-docs/
-
-## Other languages
-
-This help site is also available in other languages:
-
-- [Italiano](https://publish.obsidian.md/help-it)
-- [中文](https://publish.obsidian.md/help-zh)
-- [日本語](https://publish.obsidian.md/help-ja)
-- [Dansk](https://publish.obsidian.md/help-da)
-- [Русский](https://publish.obsidian.md/help-ru)
-- [Tiếng Việt](https://publish.obsidian.md/help-vi)
-
-## Credits
-
-[[Credits|Our credits page]] lists all the amazing people who made Obsidian possible.
-
-To read more about the makers, see the [about page](https://obsidian.md/about) on our official website.
-
-## Obsidian
-
-### About the app
-
-- See [[Obsidian|our philosophy for the app]].
-
-### Getting started
-
-- Looking for some functionality? Try the  [[command palette]], which contains all available actions you need to work with Obsidian. Just press `Ctrl/Cmd-P` and start typing.
-- Learn our flavor of Markdown with [[Format your notes|how to format your notes]].
-- Check out some tips on [[Create notes|creating new notes]].
-- Check out some tips on [[Internal link|creating internal links]].
-- Learn how to [[Embed files|embed other notes or attachments]].
-- See the [[Use hotkeys|default keyboard shortcuts]].
-
-### Official plugins
-
-![[Core plugins#Current list of official plugins]]
-
-### Advanced guides
-
-- [[Working with tags]]
-- [[Working with backlinks]]
-- [[Working with multiple notes]]
-- [[Pane layout]]
-- [[Working with multiple vaults]]
-- [[Working with multiple cursors]]
-- [[Using obsidian URI]]

posts/index.md

@@ -1,7 +1,58 @@
-### Hello, there
+## What is MindStone?
+MindStone is a free open-source alternative solution to [Obsidian Publish](https://obsidian.md/publish)
 
-Welcome to **MindStone**!
+Here how it look like once published:
 
-Let me show you how easy to publish your Obsidian Note
+![](/images/CleanShot%202022-04-20%20at%2008.34.17@2x.png)
+
+This website include a published version of default Obsidian Help vault, [[Start 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](https://github.com/TuanManhCao/digital-garden)
+2. Install [yarn](https://classic.yarnpkg.com/lang/en/docs/install/#mac-stable) package manager 
+3. Copy all of your **markdown** file (`.md` only) and folder to `/posts/` **except** `/posts/index.md` file
+4. Go to root folder of your project, run `yarn && yarn run dev`
+5. Open this link in your browser http://localhost:3000/ 
+
+If you prefer video content have a look at my walk through video in here
+**Youtube**
+
+### Publish to the internet
+
+Setup environment (with Netlify)
+1. Create your Github account and clone [my repository](https://github.com/TuanManhCao/digital-garden)
+2. Create Netlify account and follow [this instruction](https://www.netlify.com/blog/2020/11/30/how-to-deploy-next.js-sites-to-netlify/) 
 
 
+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 
+
+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:
+- Image link in wiki link style is not supported yet. `![[Image_link.png]]` will not work yet.  see work around below
+- 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.