Extension:ModDoc
![]() Release status: experimental |
|
---|---|
![]() |
|
Implementation | API |
Description | Provides Lua documentation for Scribunto. |
Author(s) | |
Compatibility policy | Master maintains backward compatibility. |
MediaWiki | |
Database changes | No |
License | GNU General Public License 2.0 or later |
Download | GitHub: Note: README, LDoc |
Translate the ModDoc extension | |
- This extension is a reimplementation of w:Module:LuaDoc, and is still under development!
ModDoc provides a framework for Lua documentation.
InstallationEdit
ModDoc depends on modules from the LuaLexer (still pending) and Scribunto extensions.
- Download and place the file(s) in a directory called
ModDoc
in yourextensions/
folder. - Add the following code at the bottom of your
LocalSettings.php
:wfLoadExtension( 'ModDoc' );
- Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
UsageEdit
For further help, see the generated ModDoc documentation.
DevelopmentEdit
For recreating the Vagrant-based development environment, see ModDoc: Topics/Vagrant.
See alsoEdit
External linksEdit
- Fandom: Module:Docbunto (similar, but not identical)