MS Docs

MS Docs

This is the documentation site for Mind Studios Dev Team

It's built using vuepress-nextopen in new window which uses Markdown for pages content.

How to run documentation site locally

  • clone thisopen in new window repository || pull latest changes from main branch
  • create new branch
  • make sure that have node.js v14 installed:
node --version
1

if node is not installed or is older than v14:

brew install nodejs
1

or if you have nvm installed:

nvm install lts/fermium
1
  • install dependencies through npm:
npm install
1
  • Run documentation site locally:
npm run docs:dev
1
  • open http://localhost:8080 in browser

How to add/edit a document

  • run project site locally if you want see changes on-the-fly
  • clone this repository || pull latest changes from main branch
  • create new branch
  • open project in your favorite IDE or text editor:

Visual Studio Code:

code .
1

Sublime Text:

subl .
1
  • change page contents
  • commit, push, send MR to main branch

Adding new page to navbar or sidebar