@pumpkin-plugins/docs API / node / generatePluginReadme

Function: generatePluginReadme()

generatePluginReadme(pluginDir, check?): Promise<Status>

Defined in: tools/docs/src/node.ts:162

Refreshes the generated blocks of a plugin's README. Everything outside the blocks is kept.

Parameters

pluginDir

string

The plugin's folder.

check?

boolean = false

Only report whether the README is out of date, without writing.

Returns

Promise<Status>

What happened to the README.

Throws

When the README doesn't exist. pnpm gen creates one for new plugins.