Documenter

About

Documenter provides an alternative way of reading information about your plugins and their commands. It formats the command list (as found in /help) to a fancy command documentation that can be exported as .html, .png or directly uploaded to Imgur.

Setup

Installation

• Download the latest plugin jar file and place it into your plugins folder
• Restart or reload your server

If you want to save the documentation as a file:

• Set imgur_upload.enabled to false in Documenter/config.yml
• Set html.enabled or image.enabled (or both) to true in Documenter/config.yml
• Use command /documenter config reload to reload your settings from config.yml

If you want to upload the documentation to Imgur:

• Create an account at Imgur if you don't already have one
• Create a new application with your Imgur account
• Replace the default value of imgur_upload.application_client_id in Documenter/config.yml with your application client ID
• Use command /documenter config reload to reload your settings from config.yml

Usage

Use command /documenter build and wait for output.
This will either save the documentation in the plugins/Documenter directory or return an Imgur image link depending on your settings.

Commands

Development

Documenter is currently in an early stage of development regarding user-friendliness and stability.
Please report bugs, typos and any weird behaviour.

MCStats

Documenter uses MCStats which sends some general server information (including your Bukkit version, your Java version and your average player count) to mcstats.org. That information is strictly anonymous and publicly available. Click here to see the Documenter statistics on MCStats. If you want to disable this feature, include opt-out: true in plugins/PluginMetrics/config.yml.

Requirements

Java 8 or above (you should be using Java 8 or above anyways)

Screenshots

Ingame chat after using /documenter build

Built with Documenter 0.1 on a server with PermissionsEx, Vault and ProtocolLib