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. 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
• Plugin development guidelines
• Stream optimization & chunked parsing
• Performance report and guidance
• Latest performance run (auto-generated)
• 最新性能报告（自动生成，中文）
• Best-of vs baseline (snapshot)
• Tuned chunk configs (latest run)
• Compatibility report (中文)
• Compatibility report (English)
• Plugin compatibility checklist
• Migration notes: markdown-it 4.x
• Migration notes: markdown-it 5.x
• Security notes
• 为什么选择 markdown-it-ts（性能对比，中文）
• Examples