jsdoc-to-markdown icon indicating copy to clipboard operation
jsdoc-to-markdown copied to clipboard

Why ##js in markdown file?

Open tst32 opened this issue 4 years ago • 2 comments

my template is

## Some here 
[![view on npm](http://img.shields.io/npm/v/example.svg)](https://www.npmjs.org/package/example)


* * *
© 2021 - tst32

jsdoc.json is

{
  "source": {
    "include": ["./src"],
    "includePattern": ".js"
  }

  }

invoke as "npx jsdoc2md --template README.hbs --configure jsdoc.json src/*.js > README.md"

and got

Some here

view on npm

js

Example


const res = uploader.DownloaderSnd()  //default sound from ...

js

все тесты здесь

Example

NODE_OPTIONS=--experimental-vm-modules jest --config jest.config.mjs


© 2021 - tst32

is this ## js how to get rid of it?

tst32 avatar Dec 23 '21 16:12 tst32

To help me reproduce the issue, please post the input source code you are documenting.. Also, try running these commands to inspect the data generated by jsdoc:

$ jsdoc2md --jsdoc --configure jsdoc.json src/*.js
$ jsdoc2md --json --configure jsdoc.json src/*.js
$ jsdoc2md --namepaths --configure jsdoc.json src/*.js

75lb avatar Dec 23 '21 18:12 75lb

Ok, I probably don't have enough knowledge how to use js-doc https://github.com/tst32/alice-uploader pushed some code to the statements are doubled in readme.md why?

tst32 avatar Dec 24 '21 12:12 tst32

Are the statements doubled because you specify input files in both the jsdoc.json file and on the command line? (jsdoc2md src/*). If you want me to reproduce your issue, please post a command I can run to see the issue myself.

75lb avatar Nov 28 '22 15:11 75lb

Closing until I get some feedback..

75lb avatar Dec 10 '22 19:12 75lb