https://github.com/askmike/gekko.wizb.it

documentation website for gekko
https://github.com/askmike/gekko.wizb.it

Last synced: about 1 year ago
JSON representation

documentation website for gekko

• Host: GitHub
• URL: https://github.com/askmike/gekko.wizb.it
• Owner: askmike
• License: mit
• Created: 2017-04-15T23:22:57.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2018-12-07T07:49:21.000Z (over 7 years ago)
• Last Synced: 2025-03-27T03:51:17.828Z (about 1 year ago)
• Language: CSS
• Homepage: https://gekko.wizb.it/
• Size: 4.22 MB
• Stars: 3
• Watchers: 2
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# README

This is the code that generates the full https://gekko.wizb.it/ website.

NOTE: all documentation is actually stored in markdown format [inside the gekko repo](https://github.com/askmike/gekko/tree/stable/docs). This code merely parses all documentation and turns it into a simple website.

# USAGE

Make sure you cloned the gekko repo as a sibling to this folder, eg.:

    /projects

      /gekko

      /gekko.wizb.it

If you are adding a new folder (new section on the left hand side menu), change `build.js` to include your section into `dirs` variable

Go into this repo and run node build:

    cd gekko.wizb.it

    npm install 

    node build

And `/site` now contains the full website.

# Running the site locally

At the top folder `gekko.wizb.it`, run command `./node_modules/http-server/bin/http-server site`