# react-wikitext

> React components for rendering wikitext.

## Guide

- [Overview](/guide/introduction.md): What react-wikitext is for, what it deliberately does not do, and when to use it.
- [Quick Start](/guide/quick-start.md): Install react-wikitext and render a wikitext snippet as React elements.
- [How It Works](/guide/concepts.md): The pipeline, the two snapshot types, entry loading boundaries, and semantic normalization.
- [Basic Usage](/guide/usage.md): Source component, explicit pipeline, async plugins, and component overrides.
- [Server Rendering](/guide/server-rendering.md): Prepare render snapshots on the server, transfer them, use Next.js App Router, and keep hydration stable.
- [Rendering Behavior](/guide/rendering.md): What the default pipeline outputs, and the stable behavior boundaries.
- [Syntax Support](/guide/syntax-support.md): Status and default output for common wikitext constructs.
- [Links and Images](/guide/links-and-images.md): Connect resolveLink and resolveImage to your router and media service.
- [Template Expansion](/guide/templates.md): Expand supported templates and pure wikitext parser functions before parsing with a host resolver.
- [Styling and Components](/guide/customization.md): Theme variables, labels, heading anchors, plugins, and component overrides.
- [Performance and Budgets](/guide/performance.md): Parsing and preparation costs, budgets, workers, caching, and entry-level bundling.
- [Security Model](/guide/security.md): Default security boundaries, sanitization order, and host responsibilities.
- [Recipes](/guide/recipes.md): Copyable snippets for theming, routing and media, template cards, article TOCs, and error reporting.
- [Troubleshooting](/guide/troubleshooting.md): Common display, build, and error-code issues, plus a fixed way to narrow them down.

## Reference

- [Entry Points](/api/index.md): Subpath capabilities, loading boundaries, and the difference between parse and render snapshots.
- [React Components](/api/react.md): Wikitext, WikitextView, WikitextFragment, component overrides, and context hooks.
- [Parsing /parse](/api/parse.md): Default parser, parse options, budgets, custom adapters, and parse errors.
- [AST /ast](/api/ast.md): Semantic node model, query helpers, source normalization, and parse snapshot serialization.
- [Preparation /hast](/api/prepare.md): Semantic tree plugins, resolvers, security policy, heading anchors, and render snapshots.
- [Expansion /expand](/api/expand.md): expandWikitext options, resolver, results, budgets, and errors.
- [unified](/api/unified.md): Raw mode for registering parsing, semantic-to-HAST conversion, and finalization in your own unified processor.
- [configs](/api/configs.md): MEDIAWIKI_CONFIG and ParserConfig.
- [Errors and Diagnostics](/api/errors.md): Error classes, codes, diagnostic fields, and handling advice.

## Project

- [Status and Compatibility](/project/status.md): Version status, runtime matrix, pinned upstream, snapshot versions, and licensing.
- [Contributing and Feedback](/project/contributing.md): Report issues, run the documentation site, edit docs, and run pre-submit checks.