create typedoc and insert it to api.md

[nosuke23]

create api document with typedoc and insert the anchor to api.md

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[MurakamiShinyu]

@nosuke23 Thanks for the contribution! I will check it. But please wait a while, I am now busy for preparing Vivliostyle.js v2.18.0, see the milestone that includes a few changes of Vivliostyle Viewer UI and I have to also update Vivliostyle Viewer User Guide.

BTW, Vivliostyle dev community uses Slack: https://vivliostyle.org/community/ could you join?

[MurakamiShinyu]

@nosuke23
I have a question. Which is the purpose of this "Vivliostyle Core API" document?

1. for people who want to develop their own software using the Vivliostyle Core API.
2. for people who want to contribute to Vivliostyle.js core and need the documentation of Vivliostyle.js core architecture.

I think the latter (2) will make more sense because for the former (1) purpose we have already Core API Reference and real examples using Vivliostyle Core, i.e., Vivliostyle Viewer, React Vivliostyle, and vivliostyle-print. (Note: Vivliostyle CLI also uses Vivliostyle Core but through Vivliostyle Viewer.)

The typedoc of whole Vivliostyle Core modules can be generated with the following command in the /packages/core directory in the vivliostyle.js repository:

typedoc --entryPointStrategy expand ./src/vivliostyle

Wouldn't it be better to use this result?

---

I ask again😀: Would you like to join Vivliostyle dev community (we are using Slack: https://vivliostyle.org/community/ )? We have monthly online meetings:

• October 2022 community#104

[nosuke23]

yes. I made changes to people allow to contribute Vivliostyle.js easier because typedoc is more useful to know the concepts of the internal modules and the architecture than reading codes directly (in addition, css features are so many). The added type definition files were copied from Vivliostyle.js directory, so I think the documents should be managed in the same repository. For now, I had inserted it because this repository is exist.

Thank you for inviting! I'll join.

[MurakamiShinyu]

I created a new repository https://github.com/vivliostyle/typedocs for the typedoc-generated documentation, and the vivliostyle.js/core's typedoc is available in https://vivliostyle.github.io/typedocs/core/.

I put TODO memos in the README of the repository.

I close this PR.