SuperJura / ESDocs

Escape Simulator Web

Current live link: https://docs.escapesimulator.com/

Installation & run locally via command line

1. clone forked repository

fork the repo on github.

then run

git clone https://github.com/SuperJura/ESDocs.git

2. download and install Nodejs

download latest LTS version.

https://nodejs.org/en

3. install dependencies

open console in the cloned repo location

then run

$ npm install

4. Start the project

$ npm start

This starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

How to add a doc

1. Create new .md file in docs folder
2. Link the .md file to the sidebar in sidebar.js
3. Modify the .md file as you wish