Skip to content

Latest commit

 

History

History

README.md

HyperRender Documentation

Welcome to the documentation for HyperRender v1.1.4 — the high-performance HTML/Markdown renderer for Flutter.

Documentation Index

Getting Started

  • Main README — Project overview, quick start, and features
  • CHANGELOG — Version history and release notes

User Guides

Document Description
Supported HTML Elements Tags and attributes supported by the engine
Known Limitations Honest list of what is not yet supported
Performance Tuning Cache configuration, virtualization, benchmarks
Migration Guide Upgrade instructions between versions
Security & Accessibility Security best practices and a11y features
Security Best Practices Hardening guide for production deployments

Developer Resources

Document Description
Plugin Development Create custom plugins and adapters
Comparison Matrix Feature comparison with FWFH and WebView
CSS Properties Matrix Full CSS property support status
Roadmap Planned features and versioning strategy
Contributing Guide How to contribute code, docs, and issues
Code of Conduct Community standards

Architecture Decision Records

Design decisions that shaped the engine, useful for contributors:

ADR Decision
0001 — UDT Model Unified Document Tree over widget composition
0002 — Single RenderObject One RenderObject vs one-per-node
0003 — CSS Float Support Float layout algorithm design
0004 — Kinsoku Processor CJK line-breaking rules
0005 — Inline Span Paradigm Continuous InlineSpan tree

Package-Specific Documentation


Quick Links by Role

For App Developers

  1. Main README — architecture and quick start
  2. Supported HTML Elements — what renders out of the box
  3. Performance Tuning — cache and virtualization settings
  4. Known Limitations — set expectations

For Contributors

  1. Contributing Guide — workflow and code standards
  2. Plugin Development — extending the engine
  3. Architecture Decision Records — why the engine works this way
  4. Roadmap — what's planned and when

For Evaluators

  1. Comparison Matrix — vs FWFH and WebView
  2. CSS Properties Matrix — CSS coverage
  3. Main README — performance benchmarks

Current stable: v1.1.4 — Last updated: March 2026