New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation #2

Open

morbidick opened this issue Aug 19, 2018 · 0 comments

Labels

enhancement help wanted

Owner

morbidick commented Aug 19, 2018

let's create one of those fancy standalone doc pages

Requirements (similar to what webcomponents.org provides)

jsdoc (with inline markdown)
separate markdown pages
inline demos
static page (no hard requirement but would be nice for hosting reasons)

Options

docz - looks really nice, but so far only react support
docma - looks nice but seems to be focused on api docs, no inline demos
vuepress - not that static, no inline demos
jsdoc3 - maybe with the tui theme, no inline demo

the inline demos could be done with the iron-demo-helpers or code-demo similar to the current demo

The text was updated successfully, but these errors were encountered:

morbidick added enhancement help wanted labels

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment