Skip to content

Latest commit

 

History

History
24 lines (17 loc) · 923 Bytes

README.md

File metadata and controls

24 lines (17 loc) · 923 Bytes

Join the chat at https://gitter.im/jsdoc2md/jsdoc2md

testbed

A collection of jsdoc2md test fixtures.

  1. Hack on your dmd fork.
  2. Checkout https://github.com/jsdoc2md/testbed
  3. In the testbed project folder run npm install
  4. Run npm link /path/to/your/dmd/fork
  5. Run node bin/cli.js --v1. This runs jsdoc2md against all the test fixtures in the build directory.
  6. Run git status.
    1. git status shows no changes
      1. Well done, you didn't break the jsdoc2md output!
    2. git status shows changes
      1. You broke something. If that was not intentional, fix the issue in your dmd fork and return to step 5.

Verify

All output produced by jsdoc2md needs to be verified as correct on these platforms:

  1. github.com
  2. npmjs.org