-
After upgrading from NodeJS 20 to NodeJS 23, jsdoc2md v9.0.2 throws a `TypeError: util.isRegExp is not a function` error when running `npx jsdoc2md src/build-index.js > docs/build-index.md`.
I have…
-
As explained in #92, when generating markdown from JS files with `CRLF` line endings the output is produced with mixed line endings.
As is the recommended fix for that issue I tried using the new `…
-
I think it's time for a major overhaul of the documentation of the `sinon` package, to make it easier to understand.
I'd like **all** our projects to have good documentation. The volume and quality…
-
Bootmark is great for a common usecase but it doesn't work with restrictive CSP (Content Security Policies) or when a document is used into an intranet without access to the internet.
The problem i…
-
This might be just an issue I have come across, but it appears that `dox` no longer supports generating documentation from a list of files or directories but instead operates only over `stdio`. I'm wo…
-
Is there a way/plan to support the generation of Python code documentation like in RST Sphinx?
See example of such generation on https://jupyter-client.readthedocs.io/en/stable/api/modules.html
…
-
I would like to use jsdoc as a module rather than installing it globally and using the cli or forking a sub process, but it isn't very clear on how to do that.
Is this possible? How?
-
Does this issue occur when all extensions are disabled?: Yes
- VS Code Version: 1.63.2
- OS Version: Darwin x64 20.6.0
Steps to Reproduce:
1. Write a JSDoc string with an e…
-
I had a whole bunch of source files that caused jsdoc2md to throw `RangeError: Maximum call stack size exceeded.` when I attempted to render them. I managed to reduce the issue down to this minimal r…
-
I'm passing `-c conf.json` to jsdoc2md:
`jsdoc2md --template readmeTpl.hbs --no-cache -c doc/conf.json --files lib/* >> README.md`
I'd like to include `lib/*` in `doc/conf.json`'s `source.includ…