Skip to main content
Version: 5.2

Build with AI

View as Markdown

AI coding assistants​

The Lightweight Charts™ repository ships two Agent Skills for AI coding assistants, such as Claude Code and Codex. The skills give the assistant current v5 knowledge to work from, instead of outdated snippets it may remember from training:

  • lightweight-charts is about using the library. It covers the v5 API conventions, the mental model, and common time, scale, marker, plugin, and wrapper foot-guns.
  • lightweight-charts-plugin-authoring is about writing a plugin. The skill helps choose between a custom series and a primitive, build on @tradingview/lwc-toolkit, and learn from the official plugin packages. It also warns about the common autoscale, whitespace, and hit-test traps. The create-lwc-plugin wizard offers to install this skill into a new plugin project.

Install either or both with the skills CLI; add --skill <name> to pick one of the two:

npx skills add tradingview/lightweight-charts

AI-friendly documentation​

The Lightweight Charts™ documentation is structured so that AI coding assistants and other LLM-based tools can read it directly, without scraping HTML, following the llms.txt convention.

llms.txt and the docs map​

The documentation root serves two index files:

  • llms.txt — a plain-text list of all documentation pages.
  • docs_map.md — the same list, including each page's headings.

Per-page Markdown​

Every documentation page is also published as plain Markdown at its own URL with an .md suffix. For example, this page is also available at ai.md.

Each page also shows two controls under its title:

  • Copy as Markdown — copies the page's Markdown to the clipboard.
  • View as Markdown — opens the page's raw Markdown in a new tab.

TypeScript definition files​

The TypeScript declaration file always matches the latest version and is hosted next to the docs at lightweight-charts.d.ts.

How to use this with AI tools​

  • Point an AI coding assistant or IDE at llms.txt so it knows which pages exist, or at a specific page's .md URL for detailed content.
  • Use the Copy as Markdown button to paste a page straight into a chat.