@minecraft/markup-generators-plugin

Plugin for @minecraft/api-docs-generator containing core markup generators and template files

latest

Source

npm

Version: 1.1.1

Version published: 2 months ago

Maintainers: 4

Created: 6 months ago

Source

@minecraft/markup-generators-plugin

This package extends @minecraft/api-docs-generator with a core set of markup generators used to generate Minecraft API scripting types and documentation.

Markup Generators

The optional run-generators argument uses a list of markup generator IDs described in the table below. If run-generators is not provided, then the generators marked as default will run:

ID	Name	Default?	Description
msdocs	MSDocs	:heavy_check_mark:	Markdown documentation for Minecraft APIs.
ts	Typescript Definitions	:heavy_check_mark:	TypeScript type definitions for Minecraft APIs.
ts-source	Typescript Source	:heavy_check_mark:	TypeScript source generation for Minecraft `vanilla-data` APIs.
npm	NPM	:heavy_check_mark:	NPM module packaging. Requires `ts` and `ts-source`.
typedoc	TypeDoc	:heavy_check_mark:	TypeDoc formatted documentation. Requires `ts` and `ts-source`.
changelog	Changelog	:heavy_check_mark:	Markdown formatted changelog output for differences between API module versions.
changelog-json	Changelog JSON		JSON changelog output.

FAQs

What is @minecraft/markup-generators-plugin?

Is @minecraft/markup-generators-plugin well maintained?

Package last updated on 29 Sep 2025

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install