Moonwave is a command line tool for generating documentation from comments in Lua source code.
This repository contains three projects:
Check out the roblox-lua-promise docs. This website is completely generated by Moonwave!
Lua is the moon. The moon is your code. The moon influences the waves in the ocean, just like your code influences its documentation. So.. moonwave!
Check out the Documentation website
Requirements:
cli
, run npm i
, npm run tsc
, and npm link
docusaurus-plugin-moonwave
, run npm i
extractor
, run cargo install --path . --locked
cli
, run npm run dev
MOONWAVE_DEV=1 moonwave dev
You should now be able to change files in the moonwave
folder and things should live-reload on your development website. If they don't, Ctrl+C the moonwave dev
terminal and restart it. If you continue to have issues, try adding the -i
flag to reinstall all dependencies.
Moonwave is available under the terms of the Mozilla Public License Version 2.0. Terms and conditions are available in LICENSE.txt or at https://www.mozilla.org/en-US/MPL/2.0/.