search

foliojs / fontkit

An advanced font engine for Node and the browser
1.47k stars 219 forks source link

Update the API documentation #117

Open Pomax opened 7 years ago

Pomax commented 7 years ago

The README.md contains some API examples (such as font.getGlyphWidth) that no longer apply/exist, so it might be worth taking the API docs out of the README.md entirely and instead generating it in a docs dir using a small docs generator based on documented code.

devongovett commented 7 years ago

Agree. I've used esdoc on some other projects, and I like it.