benderthecrime / jsdoc-preview

Markdown preview in Atom

JSDoc Preview package

Show the rendered HTML markdown to the right of the current editor using ctrl-shift-d.

It is currently enabled for .js, .javascript, and .es6 files.

NOTE: This package will ignore all JSDoc plugins and themes defined in a custom conf.json

Customize

By default, JSDoc Preview uses the default JSDoc stylesheets (minus the fonts). You can add your own css in the package settings to make it look however you would like.

• Custom Style Sheets

If you want to use a JSDoc theme, this is where you would add the stylesheets for the theme instead of defining it in conf.json.

NOTE: If you don't want to modify the other styles in your editor, wrap your custom styles in a .jsdoc-preview class.

You may also define your own JSDoc conf.json in package_settings:

• Config File Path