Skip to content

Latest commit

 

History

History
41 lines (27 loc) · 1.2 KB

README.md

File metadata and controls

41 lines (27 loc) · 1.2 KB

symbiot-docs

Documentation for the Symbiot project.

⏩ Live Site ⏪

Quickstart

Prerequisites

  • Make sure Node.js is installed and in your PATH
  • Install Grunt: npm install -g grunt-cli

Build / Run site locally

  1. Clone project
  2. Open the folder: cd symbiot-docs
  3. Install dependencies: npm install
  4. Run the dev server: grunt dev
  5. Open a browser at http://localhost:7000/

Build for Github pages (for the record)

First:

  1. Follow above steps 1, 2 and 3
  2. Build for prod: grunt prod --minifyAssets=true --baseUrl=/symbiot-docs

Then:

  1. Clone project in separate folder (ex: symbiot-docs-pages)
  2. Open the folder: cd symbiot-docs-pages
  3. Checkout Github pages branch: git checkout gh-pages
  4. Copy the content of the build folder from symbiot-docs
  5. Check status, stage, commit and push

Credits & additional documentation

Check Apidoc-Seed.

License

Under MIT License.