Skip to content

Latest commit

 

History

History

README.md

mejiro Documentation

Japanese vertical text layout engine for the web — line breaking, kinsoku shori (禁則処理), hanging punctuation, ruby (furigana), pagination, EPUB parsing/authoring, static rendering, and reader/editor components for React and Vue.

Documentation

# Title Description
01 Getting Started Installation and first layout
02 Core Concepts Architecture, data flow, TypedArrays
03 Line Breaking computeBreaks, kinsoku, hanging punctuation
04 Ruby Ruby (furigana) annotations
05 Browser Integration MejiroBrowser, font measurement
06 EPUB EPUB parsing and ruby extraction
07 Pagination & Rendering paginate, buildRenderPage, CSS
08 React & Vue Framework components
09 Advanced Custom kinsoku, token boundaries, performance, image exclusion, spread layout
10 API Reference Complete API reference

What Should I Read?

I want to lay out an EPUB quickly (recommended)Getting StartedMejiroBook in API Reference

I want to render vertical text in React or VueGetting StartedReact & Vue

I want to understand the line breaking algorithmCore ConceptsLine Breaking

I want to display an EPUB in vertical textGetting StartedEPUBPagination & Rendering

I want to use the core engine without a browserCore ConceptsAdvanced

I want to flow text around imagesMejiroBook + layout.setImages() in API Reference, or Advanced for low-level control

I want the v0.5 reader/editor surfaceReact & VueAPI Reference


← Back to README