Export MkDocs Site
Nickname: ExportMkDocs
Location: DocsHopper > Export
Description
Extracts component metadata and generates a fully configured MkDocs static website.
Inputs
| Name | Type | Access | Description |
|---|---|---|---|
| Plugin Name | Text |
item | Name of the plugin to document |
| Main Description | Text |
item | Introductory text for the site index |
| Output Directory | Text |
item | Base folder path (e.g., your local git repository path) |
| Custom Config | Text |
item | Optional custom MkDocs configuration YAML |
| Run Export | Boolean |
item | Set to true to generate the site files |
Outputs
| Name | Type | Access | Description |
|---|---|---|---|
| MkDocs Folder | Text |
item | MkDocs folder |
| Status | Text |
item | Export status message |