init

README.md

@@ -1,41 +1,59 @@
-<div align="center">
+# Gridsome X ThreeFold
 
-<a href="https://www.jammeryhq.com" title="JammeryHQ" target="_blank">
+- Any change to the content here should auto-deploy
+- All changes to the content can be seen under this link
 
-  <img src="https://jammeryhq.com/jammeryhq.png" width="128" />
-  
-</a>
+[./docs](./docs)
 
-<p>
-Fast-track your JAMstack development & learning
-</p>
-</div>
 
-<hr />
+### to get started
 
-# About the starter
+- install npm & yarn
 
-Gridsome starter based on the Casper theme for Ghost. Content is added via markdown, while Tailwind CSS is used for the layout/styling.
-
-## Key features
-
-* Built with Tailwind CSS
-* Responsive 
-* Blog
-* Author pages
-* Tags
-* Categories
-* Dynamic custom pages
-* Pagination
-
-## Installation
-
-Run the following command to create a new gridsome project 
+To install yarn on ubuntu,
 
 ```
-gridsome create my-blog https://github.com/jammeryhq/gridsome-starter-casper-v3
+curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
+echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
+apt-get -y update && apt install yarn
+```
+- git clone this repo
+- go into the repo and run ```install_gridsome.sh``` if not done yet
+- go into the repo and run ```install.sh``` which will make sure you have the node packages in your repo
+
+### Where is all the content ?
+
+- It is under the direcory [content/docs](content/docs)
+- All files are markdown (.md) format
+
+### Where are all the images ?
+
+- Under the docs directory, every service has its own folder and own set of images
+- To use an image for crystal twin, naviagte to crystal twin's folder and place the image as below,
+
+```
+![](./crystaltwin.png)
+
+```
+### Editing md files
+
+- All files start with this piece of code, this is meant to control navigation into different sections defined in the sidebar menu.
+```
+---
+description: ''
+sidebar: 'docs'
+prev: '/docs/wiki-publisher/'
+next: '/docs/digitalme/'
+---
+```
+## You want to go deeper ?
+
+![https://docc-theme.netlify.app](https://docc-theme.netlify.app)
+
+
+to install a new version of this
+
+```
+gridsome create threefold-now https://github.com/mrcrmn/docc
 ```
 
-## Credits
-
-This starter is based on [Ghost Casper V3](https://github.com/TryGhost/Casper).