Skip to content
This repository has been archived by the owner on Sep 11, 2020. It is now read-only.

Markdown generation from JSDoc comments #87

Closed
da-kami opened this issue Jan 16, 2020 · 6 comments · Fixed by #110
Closed

Markdown generation from JSDoc comments #87

da-kami opened this issue Jan 16, 2020 · 6 comments · Fixed by #110
Assignees

Comments

@da-kami
Copy link
Member

da-kami commented Jan 16, 2020

The recommendation by the documentation spike is to use https://documentation.js.org/ for this.

@yosriady
Copy link

I'll pick this up.

@D4nte
Copy link

D4nte commented Jan 17, 2020

I'll pick this up.

You can assign it to yourself now that I added you to comit-network :)

@yosriady yosriady self-assigned this Jan 17, 2020
@yosriady
Copy link

Alternatively https://doc.esdoc.org/github.com/esdoc/esdoc/, which seems to have better support for hand-written documentation.

@yosriady
Copy link

@da-kami
Copy link
Member Author

da-kami commented Jan 21, 2020

Alternatively doc.esdoc.org/github.com/esdoc/esdoc, which seems to have better support for hand-written documentation.

Is markdown supported? (marked as PoC https://esdoc.org/manual/feature.html - https://github.com/esdoc/esdoc-plugins/tree/master/esdoc-publish-markdown-plugin)
We CAN opt for HTML integration as well, but the idea was to start with Markdown first.

@yosriady
Copy link

yosriady commented Jan 21, 2020

What I'm going to do is start by trying documentation.js and to see if it serves our use case. It does seem to support Typescript and may also have handwritten support.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants