Skip to content

JSDoc: Generated documentation #1777

@RunDevelopment

Description

@RunDevelopment

Why don't we use JSDoc to add generated code documentation to the prismjs.com website? I'm thinking about something like prismjs.com/docs/.

The generated documentation will include all documented variables/functions of components/prism-core.js. Functions that aren't documented won't show up in the doc.
I already tested this a little and it works quite well.

This is intended to replace the API section of extending Prism to keep Core and its documentation more in sync to avoid issues like #1774.

(We can also use this include API docs for plugins and components like markup templating in the future.)

Thoughts?
@mAAdhaTTah @Golmote @LeaVerou

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions