CARVIEW |
Select Language
HTTP/2 200
date: Thu, 24 Jul 2025 12:40:12 GMT
content-type: text/html; charset=utf-8
vary: X-PJAX, X-PJAX-Container, Turbo-Visit, Turbo-Frame, X-Requested-With,Accept-Encoding, Accept, X-Requested-With
x-robots-tag: none
etag: W/"32a3392995dbf2286a7d3aac7a33a0fe"
cache-control: max-age=0, private, must-revalidate
strict-transport-security: max-age=31536000; includeSubdomains; preload
x-frame-options: deny
x-content-type-options: nosniff
x-xss-protection: 0
referrer-policy: no-referrer-when-downgrade
content-security-policy: default-src 'none'; base-uri 'self'; child-src github.githubassets.com github.com/assets-cdn/worker/ github.com/assets/ gist.github.com/assets-cdn/worker/; connect-src 'self' uploads.github.com www.githubstatus.com collector.github.com raw.githubusercontent.com api.github.com github-cloud.s3.amazonaws.com github-production-repository-file-5c1aeb.s3.amazonaws.com github-production-upload-manifest-file-7fdce7.s3.amazonaws.com github-production-user-asset-6210df.s3.amazonaws.com *.rel.tunnels.api.visualstudio.com wss://*.rel.tunnels.api.visualstudio.com objects-origin.githubusercontent.com copilot-proxy.githubusercontent.com proxy.individual.githubcopilot.com proxy.business.githubcopilot.com proxy.enterprise.githubcopilot.com *.actions.githubusercontent.com wss://*.actions.githubusercontent.com productionresultssa0.blob.core.windows.net/ productionresultssa1.blob.core.windows.net/ productionresultssa2.blob.core.windows.net/ productionresultssa3.blob.core.windows.net/ productionresultssa4.blob.core.windows.net/ productionresultssa5.blob.core.windows.net/ productionresultssa6.blob.core.windows.net/ productionresultssa7.blob.core.windows.net/ productionresultssa8.blob.core.windows.net/ productionresultssa9.blob.core.windows.net/ productionresultssa10.blob.core.windows.net/ productionresultssa11.blob.core.windows.net/ productionresultssa12.blob.core.windows.net/ productionresultssa13.blob.core.windows.net/ productionresultssa14.blob.core.windows.net/ productionresultssa15.blob.core.windows.net/ productionresultssa16.blob.core.windows.net/ productionresultssa17.blob.core.windows.net/ productionresultssa18.blob.core.windows.net/ productionresultssa19.blob.core.windows.net/ github-production-repository-image-32fea6.s3.amazonaws.com github-production-release-asset-2e65be.s3.amazonaws.com insights.github.com wss://alive.github.com api.githubcopilot.com api.individual.githubcopilot.com api.business.githubcopilot.com api.enterprise.githubcopilot.com; font-src github.githubassets.com; form-action 'self' github.com gist.github.com copilot-workspace.githubnext.com objects-origin.githubusercontent.com; frame-ancestors 'none'; frame-src viewscreen.githubusercontent.com notebooks.githubusercontent.com; img-src 'self' data: blob: github.githubassets.com media.githubusercontent.com camo.githubusercontent.com identicons.github.com avatars.githubusercontent.com private-avatars.githubusercontent.com github-cloud.s3.amazonaws.com objects.githubusercontent.com release-assets.githubusercontent.com secured-user-images.githubusercontent.com/ user-images.githubusercontent.com/ private-user-images.githubusercontent.com opengraph.githubassets.com copilotprodattachments.blob.core.windows.net/github-production-copilot-attachments/ github-production-user-asset-6210df.s3.amazonaws.com customer-stories-feed.github.com spotlights-feed.github.com objects-origin.githubusercontent.com *.githubusercontent.com; manifest-src 'self'; media-src github.com user-images.githubusercontent.com/ secured-user-images.githubusercontent.com/ private-user-images.githubusercontent.com github-production-user-asset-6210df.s3.amazonaws.com gist.github.com; script-src github.githubassets.com; style-src 'unsafe-inline' github.githubassets.com; upgrade-insecure-requests; worker-src github.githubassets.com github.com/assets-cdn/worker/ github.com/assets/ gist.github.com/assets-cdn/worker/
server: github.com
content-encoding: gzip
accept-ranges: bytes
set-cookie: _gh_sess=fcJNYHwl7H0ohcEfcSdvQJ%2Be0ymdLKJo%2FB34%2Br2Hcs14mj7xwCPrKohhL5NQOPu4XsGs9juNyV5QWy9oj%2F%2FGCY2Y%2B1632FQrNPm6R3arXq5RZRjPsZNpj308oH%2BIqLkQf35m7ymmvUfU05D4LEYbwWVNRQuLCQnH9eFP3yIJo%2FfBv%2BbA6T8lWk4kBdJgQnL4W%2B%2FrRni94mDvfO%2FfNd85GSLfP0mrZ%2F5D5Qrr8rAfni0Oxv0Mp6vjIArlwZhBdxBOqx1Qeq60i4wBM83d%2FqvINg%3D%3D--e8c%2B90Jx9na5BfUe--SV38%2BqRgNxA033kCRiQDOQ%3D%3D; Path=/; HttpOnly; Secure; SameSite=Lax
set-cookie: _octo=GH1.1.728516199.1753360811; Path=/; Domain=github.com; Expires=Fri, 24 Jul 2026 12:40:11 GMT; Secure; SameSite=Lax
set-cookie: logged_in=no; Path=/; Domain=github.com; Expires=Fri, 24 Jul 2026 12:40:11 GMT; HttpOnly; Secure; SameSite=Lax
x-github-request-id: CFEE:2335D5:657E11:70F88E:688229AB
Create a README template · jsdoc2md/jsdoc-to-markdown Wiki · GitHub
Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 151
Create a README template
Lloyd Brookes edited this page Oct 9, 2016
·
1 revision
jsdoc2md currently uses handlebars to generate the output. The partials and helpers involved in creating the output are managed by the dmd project.
The default template content is simply '{{>main}}'
, which renders the output of this handlebars partial. So, a README template could be created by dropping {{>main}}
into your standard README structure. Step by step tutorial:
1. Create a file name README.hbs with this content.
[](https://www.npmjs.org/package/example)
{{>main}}
* * *
© 1942-2016 Muhammad Ali
2. Write some documented source code, e.g.
/**
* A module for adding two values.
* @module add-two-values
*/
/**
* Add two values.
* @alias module:add-two-values
*/
function add (a, b) {
return a + b
}
module.exports = add
3. Use the custom template by passing its filename to the --template
option:
$ jsdoc2md --template README.hbs --files example.js
4. Output:
A module for adding two values.
Add two values.
Kind: Exported function
© 1942-2016 Muhammad Ali
- Home
- How jsdoc2md works
- Additional jsdoc tags supported
- Cherry picking which documentation appears in output
- Showcase ...
- Create ...
- How To ...
- How to use with npm run
- How to use with gulp
- How to create one output file per class
- How to document a AMD module
- How to document a CommonJS module (exports)
- How to document a CommonJS module (module.exports)
- How to document an ES2015 module (multiple named exports)
- How to document an ES2015 module (single default export)
- How to document Promises (using custom tags)
- How to document a ToDo list
- How to document ES2017 features
- How to document TypeScript
- The @typicalname tag
- Linking to external resources
- Param list format options
- Listing namepaths
- Troubleshooting
Clone this wiki locally
You can’t perform that action at this time.