Git Product home page Git Product logo

sfdoc's Introduction

sfdoc

CLI utility to parse Starfall's documentation and generate meta files for lua language server and snippet files for vscode.

Basic usage

Parse the documentation out of the code into a json file.

sfdoc parse <path to starfall>/lua/starfall/libs_*

This will create a docs.json file need to generate the meta files and snippets.

Generate the meta files.

sfdoc generate meta

This will use the docs.json and create a directory named docs with the documentation inside.

Generate the snippets.

sfdoc generate snippets

This will create a file named starfall.code-snippets.

Open your starfall folder, .../GarrysMod/garrysmod/data/starfall/ with vscode and change the settings to contain:

    "Lua.workspace.library": [
        "<path to the generated docs/ directory>",
    ],
    "Lua.runtime.nonstandardSymbol": [
        "//",
        "/**/",
        "!",
        "||",
        "&&",
        "!=",
        "continue",
    ],
    "files.associations": {
        "*.txt": "lua",
    }

and move the starfall.code-snippets into the .vscode folder.

sfdoc's People

Contributors

diogo464 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.