Skip to content

Documentation #2

Description

@morbidick

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

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requesthelp wantedExtra attention is needed

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions