vivliostyle/vivliostyle.org

Can't find documentation for plugin.registerHook

Opened this issue · 2 comments

I want to migrate from Paged.js to Vivliostyle.js, and I wrote hooks to run at atBreakToken and at renderNode to modify breaks of my document. Vivliostyle documentation doesn't provide information about types of hooks available.

Thank you for your question. Unfortunately, the documentation for plugin.registerHook and its usage examples are found only in the source code of Vivliostyle.js. See the source code https://github.com/vivliostyle/vivliostyle.js/blob/master/packages/core/src/vivliostyle/plugin.ts and find the usage of plugin.registerHook. Several vivliostyle features have been added by using plugin.registerHook mechanism. The following pull requests may be helpful as examples:

Thank you! Those documentation and examples are enough for me. I hope , however, there is a plan to put the documentation in the website.