site

Generate Docusaurus MDX or JSON documentation sites from Starlake metadata.

1|1|Updated Mar 4, 2026
One-click install
npx skills add https://github.com/starlake-ai/starlake-skills --skill site
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: site
Source: https://github.com/starlake-ai/starlake-skills/tree/main/skills/site
Command: npx skills add https://github.com/starlake-ai/starlake-skills --skill site

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Centralizes and automates the creation of developer-facing documentation for Starlake projects so teams no longer manually assemble domain, table, and transform documentation or keep docs in sync with code and schemas.

Core Features & Use Cases

  • Comprehensive Site Generation: Produces a full documentation website that includes domains, tables, attributes, transforms, and their relationships.
  • Flexible Output Formats: Supports Docusaurus MDX and machine-readable JSON outputs and accepts custom templates and output directories.
  • Use Case: Quickly generate a browsable site for stakeholders or an exportable JSON artifact for CI pipelines that validates and publishes the current metadata snapshot.

Quick Start

Run the site skill to generate a documentation website in your chosen format and output directory using the starlake CLI with appropriate template and clean options.

Frequently Asked Questions about site

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I auto-generate Starlake project documentation from schema definitions?

Generate Starlake project documentation websites from project metadata and schema definitions using the site skill, which automates the creation of developer-facing docs for domains, tables, attributes, and transforms to keep everything in sync without manual effort.

Can I export Starlake metadata as Docusaurus MDX or JSON files?

Yes, you can export Starlake metadata as Docusaurus MDX or JSON files. The site skill supports both formats, enabling you to produce browsable MDX documentation or machine-readable JSON artifacts for CI pipelines.

Does the Starlake site generation tool support custom templates and output cleaning?

Yes, the Starlake site generation tool supports configurable output directories, custom templates, and the cleaning of output directories. It also provides report output options such as console, JSON, or HTML formats to suit different workflow needs.

What is the best way to keep Starlake transform and lineage documentation in sync with code?

The best way to keep Starlake transform and lineage documentation in sync with code is to automate creation via the site skill, which generates up-to-date documentation websites from current metadata and schema definitions, eliminating manual updates.

How do I include lineage and transforms when generating a Starlake documentation website?

To include lineage and transforms when generating a Starlake documentation website, run the site skill against your project metadata; it automatically maps relationships, domains, tables, and transforms into a structured Docusaurus or JSON site.