I have this post for documenting my project: Sync API docs, I've just added the repository link there.
I haven't updated the docs above yet because the typings are still changing, but it should be in markdown, maybe similar to axios. I see that Joplin documentation website also in markdown, so later I can use that to render if possible