Skip to content

DocsHopper Documentation

DocsHopper is a utility Grasshopper plugin that extracts component metadata directly from your loaded Grasshopper assemblies and generates static documentation websites. Whether you need a lightweight vanilla HTML page or a fully customized MkDocs Material site deployed to GitHub Pages, DocsHopper handles the entire pipeline within the Grasshopper canvas.

Key features

  • Metadata Extraction: Automatically reads component names, categories, descriptions, and inputs/outputs from any loaded .gha assembly.

  • Multiple Export Formats: Export your documentation as zero-dependency HTML/CSS, structured Markdown, raw JSON, or a complete MkDocs site.

  • Advanced Customization: Inject custom CSS, MkDocs YAML configurations, and build rich homepage sections with text and screenshots natively in Grasshopper.

  • Live Previewing: Spin up local Python servers for MkDocs or instantly open HTML exports in your default browser.

  • One-Click Deployment: Automatically generate GitHub Actions .yml files to push your documentation straight to GitHub Pages.

  • Embedded Templates: Right-click the Templates component to instantly drop pre-wired documentation setups onto your canvas.

Key features

Installation

DocsHopper is available via the Rhino Package Manager (YAK):

  • Open Rhino.

  • Type _PackageManager in the command line.

  • Search for DocsHopper.

  • Click Install and restart Rhino.

Components by Subcategory

Customize

Name Description
Custom MKDocs Generates custom YAML configuration settings for the MkDocs Material theme.
Create Homepage Section Creates a custom text/image section for the Advanced MkDocs homepage.
Custom CSS Creates a custom CSS style string for the HTML documentation.

Deploy

Name Description
Deploy MkDocs Creates a .yml file and pushes the repo to GitHub to trigger GitHub Pages.

Export

Name Description
Export JSON Serializes component metadata and Base64 icons into a single headless .json file.
Export MkDocs Site Extracts component metadata and generates a fully configured MkDocs static website.
Export DocsHopper Extracts component metadata and exports it as structured Markdown documentation.
Export Advanced HTML/CSS Extracts component metadata and generates a customized HTML/CSS static website.
Export Advanced MkDocs Site Extracts component metadata and generates a customized MkDocs static website.
Export HTML/CSS Generates a zero-dependency, static HTML/CSS website for your documentation.

Preview

Name Description
Preview MkDocs Launches a local MkDocs server, opens your browser, and provides an option to install dependencies.
Preview HTML Opens the generated HTML documentation in your default web browser.

Util

Name Description
DocsHopper Templates Right-click this component to insert pre-made documentation templates onto your canvas.
Plugin Reader Reads all the plugin information available.