Skip to content

Documentation generation #7

@vallode

Description

@vallode

Since Lua language server (LLS) provides a --doc option to output a raw and verbose JSON of all the tokens it defines we can use that to generate documentation to be served online.

LLS already provides a barebones markdown file as an example, this could be taken further using a static site generator (SSG) with some pre-defined API documentation theme to increase accessibility to the DFHack Lua API...

SSGs to consider are:

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions