# quickinfo

> IDE-style API hovers for docs sites.

## Docs

- [Introduction](https://rachfop.github.io/quickinfo): Editor-style API hovers for Docusaurus, Astro, Sphinx, MkDocs, and any other static site generator.
- [Get started](https://rachfop.github.io/quickinfo/get-started): Add quickinfo to your docs site by handing one prompt to your LLM coding assistant.

## Integrations

- [Set up Docusaurus](https://rachfop.github.io/quickinfo/docusaurus): Register the quickinfo plugin and rehype pass in a Docusaurus site.
- [Set up Astro](https://rachfop.github.io/quickinfo/astro): Add the quickinfo integration to an Astro site, Starlight included.
- [Set up Blume](https://rachfop.github.io/quickinfo/blume): Add the quickinfo integration to a Blume docs site.
- [Set up Sphinx](https://rachfop.github.io/quickinfo/sphinx): Add quickinfo hovers to a Sphinx site with autodoc.
- [Set up MkDocs](https://rachfop.github.io/quickinfo/mkdocs): Add quickinfo hovers to an MkDocs site with mkdocstrings.
- [Set up any static site generator](https://rachfop.github.io/quickinfo/script-tag): Load quickinfo with a script tag on Hugo, Jekyll, plain HTML, or any other static site generator.

## Reference

- [Index files](https://rachfop.github.io/quickinfo/index-files): The names JSON and info JSON schemas every quickinfo setup reads.
- [Symbol resolution](https://rachfop.github.io/quickinfo/resolution): The matching rules that map identifiers in code and prose to indexed symbols.
- [API reference](https://rachfop.github.io/quickinfo/api-reference): Every export, option, and data file the plugin ships.

## Agent skills

- [quickinfo](https://rachfop.github.io/quickinfo/.well-known/agent-skills/quickinfo/SKILL.md): Read the quickinfo docs instead of answering from memory. IDE-style API hovers for docs sites. Use when a task involves quickinfo: how it works, how to set it up or configure it, or its API.

## Agent resources

- [llms-full.txt](https://rachfop.github.io/quickinfo/llms-full.txt): The full Markdown of every page in one file.
- [Page Markdown](https://rachfop.github.io/quickinfo/index.md): Append `.md` to any page URL to fetch that page as raw Markdown.
- [JSON API](https://rachfop.github.io/quickinfo/api/docs/pages.json): Page index of the JSON docs API; each entry links the page's JSON and Markdown forms. Described by the OpenAPI document at https://rachfop.github.io/quickinfo/openapi.json.
- [Agent skills](https://rachfop.github.io/quickinfo/.well-known/agent-skills/index.json): Agent Skills discovery index of the skills this site publishes.
- [API catalog](https://rachfop.github.io/quickinfo/.well-known/api-catalog): RFC 9727 linkset of the APIs documented here.
- [AI catalog](https://rachfop.github.io/quickinfo/.well-known/ai-catalog.json): ARD manifest of the agent-facing resources on this site (MCP server, skills, APIs).
- [agent-readability.json](https://rachfop.github.io/quickinfo/agent-readability.json): Manifest of every agent-facing artifact on this site.
- [Sitemap](https://rachfop.github.io/quickinfo/sitemap.xml): Every indexable page URL with its last-modified date.