glua-docs
glua-docs copied to clipboard
:mag: Quick documentation lookup for Garry's Mod Lua
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
Build
yarn
yarn build
Deploy
The app is deployed to the gh-pages branch.
yarn deploy