Skip to content

Generate better API documentation #6526

Open
@brendandahl

Description

@brendandahl

The api docs at https://mozilla.github.io/pdf.js/api/draft/ are really bad. We have a lot of good information in api.js and in other files but it doesn't seem to be parsed correctly. Things we should look into:

  • fixing the docs in the js file so they are more compatible with jsdoc
  • add some more examples within the docs
  • document the viewer api
  • update the theme so it includes our gh-pages header/footer

If anyone is willing to look into this, I'm happy to mentor and/or quickly review pull requests.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions