https://github.com/samuelmaddock/glua-docs

:mag: Quick documentation lookup for Garry's Mod Lua
https://github.com/samuelmaddock/glua-docs

documentation garrysmod gmod

Last synced: 3 months ago
JSON representation

:mag: Quick documentation lookup for Garry's Mod Lua

• Host: GitHub
• URL: https://github.com/samuelmaddock/glua-docs
• Owner: samuelmaddock
• License: mit
• Created: 2013-06-24T15:02:19.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2020-09-04T10:05:54.000Z (over 4 years ago)
• Last Synced: 2024-04-13T21:56:32.373Z (10 months ago)
• Topics: documentation, garrysmod, gmod
• Language: JavaScript
• Homepage: https://samuelmaddock.github.io/glua-docs/
• Size: 3.11 MB
• Stars: 19
• Watchers: 3
• Forks: 8
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](http://wiki.garrysmod.com/page/Main_Page).

It's suggested not to run this too often as to respect bandwidth usage.

[Node.js](http://nodejs.org/) is required to run the scraper.

    cd scraper

    npm install         # install node.js dependencies (see package.json)

    node scrape.js     # run the scraper

    

## Build ##

```bash

yarn

yarn build

```

## Deploy ##

The app is deployed to the `gh-pages` branch.

```bash

yarn deploy

```