Jump to content

Extension:ModDoc

From mediawiki.org
MediaWiki extensions manual
ModDoc
Release status: experimental
Implementation API
Description Provides Lua documentation for Scribunto.
Author(s)
  • John Erling Blad (Jebladtalk)
Compatibility policy Master maintains backward compatibility.
MediaWiki 1.33+
Database changes No
License GNU General Public License 2.0 or later
Download
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.

Installation

[edit]

ModDoc depends on modules from the LuaLexer (still pending) and Scribunto extensions.

  • Download and place the file(s) in a directory called ModDoc in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'ModDoc' );
    
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Usage

[edit]

For further help, see the generated ModDoc documentation.

Development

[edit]

For recreating the Vagrant-based development environment, see ModDoc: Topics/Vagrant.

See also

[edit]
[edit]