For AI agents: the complete documentation index is available at /next/llms.txt, the full documentation bundle is available at /next/llms-full.txt, and this page is available as Markdown at /next/ai/skills/lynx-api-docs.md.
AI logo
AI
  • English
  • lynx-api-docs

    The lynx-api-docs Agent Skill gives coding agents local references for public Lynx elements, CSS, layout systems, common patterns, Web migration, and best practices. Its references are sourced from the Lynx engine's @lynx-js/lynx-api-docs package.

    Use it when an agent needs to:

    • implement or review Lynx pages, templates, components, or styles
    • verify supported public elements, attributes, CSS properties, selectors, values, or units
    • choose between Linear, Flex, Grid, and Relative layout
    • account for Lynx behavior that differs from the Web platform
    • debug rendering or styling issues without guessing from general Web knowledge

    Installation

    npx skills add lynx-community/skills -s lynx-api-docs

    This installs the lynx-api-docs skill with its bundled public API references so compatible coding agents can load the relevant documentation automatically.

    Info

    This skill provides context for coding agents. It is not a runtime dependency of a Lynx application.

    Using the Skill

    Compatible coding agents can activate lynx-api-docs automatically when working on Lynx code. You can also request it explicitly:

    Use lynx-api-docs to verify the supported properties and events for
    <scroll-view> before implementing this component.

    The skill requires the agent to read the relevant installed references before editing Lynx code. It routes different tasks to focused documents, such as:

    • elements/<element-name>.md for element attributes, events, and methods
    • css/ for supported properties, selectors, values, units, and pseudo-classes
    • layout/ for Linear, Flex, Grid, and Relative layout
    • lynx-vs-web/ for Web migration and behavior differences
    • patterns/ and best-practices.md for common implementation guidance

    Updating

    Run the installation command again to update the skill and its bundled references:

    npx skills add lynx-community/skills -s lynx-api-docs

    Learn More

    Except as otherwise noted, this work is licensed under a Creative Commons Attribution 4.0 International License, and code samples are licensed under the Apache License 2.0.