Skip to content

Latest commit

 

History

History
24 lines (19 loc) · 975 Bytes

README.md

File metadata and controls

24 lines (19 loc) · 975 Bytes
Raw

Garry's Mod Lua Docs

Quick documentation lookup for Garry's Mod Lua, inspired by http://dochub.io/

Features

  • Faster documentation lookup
  • Sorted by Lua state (server, shared, client, menu)
  • Code syntax highlighting
  • Offline availability
  • Links back to wiki

Scraper

Updating GLua Docs involves scraping the Garry's Mod Wiki. It's suggested not to run this too often as to respect bandwidth usage. Node.js is required to run the scraper.

cd scraper
npm install         # install node.js dependencies (see package.json)
node scrape.js     # run the scraper

Building

Grunt is used to run various processes on the code prior to deployment. Reading through the Getting Started guide should help in setting up Grunt. Simply run grunt from the command line to build the necessary project files into /app