Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation generation #7

Open
vallode opened this issue May 3, 2024 · 0 comments
Open

Documentation generation #7

vallode opened this issue May 3, 2024 · 0 comments

Comments

@vallode
Copy link
Owner

vallode commented May 3, 2024

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:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant