Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

JSDoc: Generated documentation

See original GitHub issue

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

Issue Analytics

State:
Created 5 years ago
Comments:5 (3 by maintainers)

Top GitHub Comments

1reaction

Gahencommented, Jun 28, 2020

Thank you @RunDevelopment ❤️

0reactions

RunDevelopmentcommented, Jun 27, 2020

@Gahen I re-did #1782 and we might be able to merge it within the next few days.

Top Results From Across the Web

Getting Started with JSDoc 3

JSDoc 3 is an API documentation generator for JavaScript, similar to Javadoc or phpDocumentor. You add documentation comments directly to your source code, ......

jsdoc/jsdoc: An API documentation generator for JavaScript.

An API documentation generator for JavaScript. Want to contribute to JSDoc? Please read CONTRIBUTING.md . Installation and Usage. JSDoc supports stable versions ...

Generate jsdoc documentation - javascript - Stack Overflow

I add jsdocs to typical javascript project by adding a script to package.json "scripts": { ... "docs": "./node_modules/jsdoc/jsdoc.js -c .

Document your Javascript code with JSDoc - DEV Community ‍ ‍

JSDoc is an open source API documentation generator for Javascript. It allows developers to document their code through comments.

Documenting JavaScript Code With JSDocs - Section.io

The main idea behind JSDocs is to generate documentation for functions, classes, and methods. The benefit of using JSDocs for your code is ......