8000 GitHub - bladewindui/docs: Documentation for the BladewindUI components library · GitHub
[go: up one dir, main page]

Skip to content
  • bladewinduiPublic

    About

    Documentation for the BladewindUI components library

    Topics

    Resources

    Stars

    4 stars

    Watchers

    0 watching

    Forks

    Repository files navigation

    License


    This is the Laravel application that powers bladewindui.com — the documentation site for BladewindUI, a collection of UI components written purely using TailwindCSS, Laravel Blade templates and vanilla JavaScript.

    The component library itself lives in a separate repo: bladewindui/ui. That is also where installation instructions and the full, always-current component list live, so they are not repeated here — this README would just go stale a second time. See its README for both, or the live, generated versions at bladewindui.com/install and bladewindui.com/components.


    MCP Documentation

    The mcp/ directory contains clean, machine-readable Markdown documentation for every component. These files are intended for consumption by MCP (Model Context Protocol) servers so that AI assistants can understand how to use BladewindUI components.

    Each file includes frontmatter, prose descriptions, fenced blade code examples, and a full attribute reference table. An index of all components is at mcp/index.md.

    Generating MCP docs for new components

    When you add a new component to the documentation site, run generate-mcp.php to produce its MCP entry automatically.

    Requirements: PHP 8+, an Anthropic API key.

    export ANTHROPIC_API_KEY=sk-ant-...

    Generate a new entry:

    php generate-mcp.php <component-name>

    Preview without writing files:

    php generate-mcp.php <component-name> --dry-run

    Generate and add to mcp/index.md:

    php generate-mcp.php <component-name> --update-index

    The script looks for resources/views/docs/<component-name>.blade.php. If the blade filename differs from the component slug (e.g. empty-state → emptystate.blade.php), add an entry to the $FILENAME_OVERRIDES map near the top of generate-mcp.php.



    Questions and General Info

    If you want to ask anything at all or report a security vulnerability, please e-mail mike@bladewindui.com or tweet @bladewindui


    License

    BladewindUI is an open-sourced library licensed under the MIT license.

    About

    Documentation for the BladewindUI components library

    Topics

    Resources

    Stars

    4 stars

    Watchers

    0 watching

    Forks

    Releases

    Packages

    Used by

    Contributors

    Languages

    0