# Documentation

This folder contains reference material for people extending `markdown-it-ts`.

If you are consuming the package and only need the runtime API, start with the
project [`README`](../README.md). The upstream markdown-it documentation remains
fully applicable for feature semantics, and we call out TypeScript-specific
gotchas or enhancements here when needed.

## Index

- [Parser architecture & design principles](architecture.md)
- [Plugin development guidelines](development.md)
- [Stream optimization & chunked parsing](stream-optimization.md)
- [Performance report and guidance](perf-report.md)
- [Latest performance run (auto-generated)](perf-latest.md)
- [最新性能报告（自动生成，中文）](perf-latest.zh-CN.md)
- [Best-of vs baseline (snapshot)](perf-best-vs-baseline.md)
- [Tuned chunk configs (latest run)](tuned-chunk-config.md)
- [Compatibility report (中文)](COMPATIBILITY_REPORT.md)
- [Compatibility report (English)](COMPATIBILITY_REPORT.en.md)
- [Plugin compatibility checklist](PLUGIN_COMPATIBILITY_CHECK.md)
- [Migration notes: markdown-it 4.x](4.0_migration.md)
- [Migration notes: markdown-it 5.x](5.0_migration.md)
- [Security notes](security.md)
- [为什么选择 markdown-it-ts（性能对比，中文）](why-switch.zh-CN.md)
- [Examples](./examples)