docs-index
Generate deterministic Megamono documentation indexes
When to use it
Generate deterministic Megamono documentation indexes. Use this when you want to add the corresponding files or task to your workspace.
Usage
Configure an Nx target on the owning project, then invoke it with npm exec -- nx run <project>:<target>. The executor identifier is not a standalone CLI command.
{
"targets": {
"reviewed-action": {
"executor": "@megamono/plugin:docs-index",
"options": {}
}
}
}This target is a configuration example. Supply required values and review side effects before invoking it.
Options
Use these options with @megamono/plugin:docs-index. Nx uses the camelCase names shown here; the CLI reference describes command-line aliases. Some options are required only for particular choices.
| Option | Required | Type | Default | Description |
|---|---|---|---|---|
config | No | string | "megamono.json" | — |
docsRoot | No | string | — | — |
check | No | boolean | false | Fail when index files are stale instead of updating them. |
Next steps
Review changed files and run the affected project's checks. For options that accept structured values, run the generator's --help or consult the schema in the installed package.
