Business
Jobs
  • About Us
  • Solutions
    • Job Postings
      Post your job and receive qualified candidates in 48h.
    • Candidate Assessments
      500+ technical and psychological tests, plus anti-fraud.
    • Headhunting
      Tailor-made executive search from start to finish.
    • Payroll + EOR
      Payroll dispersal and EOR across 15+ LATAM countries.
  • Pricing
  • Jobs

0

137
Views
How to generate single JSDoc for a monorepo which include several packages with individual Readme files?

I have been trying to generate single JSdoc for multiple packages in a monorepo(lerna used here). And also each package have it's own readme. On the top level there is a generic readme files. The library used for the purpose is here. What's the possible way to generate JSDoc ?

Configured Jsdoc based on config:

{
"tags": {
    "allowUnknownTags": false
},
"plugins": [
    "plugins/markdown"
],
"source": {
    "include": [
        "packages/A/",
        "packages/B/"
    ],
    "excludePattern": "\\.(?:|spec|test)\\.js$"
},
"sourceType": "module",
"opts": {
    "readme": "README.md",
    "template": "templates/default",
    "encoding": "utf8",
    "destination": "doc/",
    "access": "public",
    "recurse": true,
    "verbose": true
},
"markdown": {
    "parser": "gfm",
    "hardwrap": true
},
"templates": {
    "cleverLinks": true,
    "monospaceLinks": false
}
}

Jsdoc generated for config with multiple sources listed properly in array.

"source": {
    "include": [
        "packages/A/",
        "packages/B/"
    ],
    "excludePattern": "\\.(?:|spec|test)\\.js$"
}

However Readme.md available in the every package of the monorepo not listed anywhere. Only the root level Readme.md available and rest of the packages readme not exists anywhere in the generated JSdoc. I couldn't figure it out a way to list all readme under corresponding module A & B specified source config. Configuration which I doubted is

"opts": {
    "readme": "README.md",
    "template": "templates/default",
    "encoding": "utf8",
    "destination": "doc/",
    "access": "public",
    "recurse": true,
    "verbose": true
}

especially readme attribute in opts object mapped to the root level readme. Is it possible to provide all the monorepo packages readme in Opts ?

The link to refer configuration.

Any suggestions to generate JSdoc to monorepo is much appreciated. Thanks!

about 4 years ago · Juan Pablo Isaza
Answer question
Find remote jobs

Discover the new way to find a job!

Top jobs
Top job categories
Business
Post vacancy Pricing Sales
Legal
Terms and conditions Privacy policy
© 2026 PeakU Inc. All Rights Reserved.
Andres GPT
Show me some job opportunities
There's an error!