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

jsdoc-preview's Issues

JSDoc-Preview hangs on "Loading JSDoc..."

1. Open JavaScript file with JSDoc notation comments in Atom
2. Click Packages->JSDoc Preview-> Toggle Prview
3. Get a Preview screen on right side of Atom editor with white background and message "Loading JSDoc.."

Failed to activate the jsdoc-preview package

[Enter steps to reproduce:]

1. Open Atom in a project with atom .
2. Watch error

Atom: 1.15.0 ia32
Electron: 1.3.13
OS: Unknown Windows version
Thrown From: jsdoc-preview package 1.2.1

Stack Trace

Failed to activate the jsdoc-preview package

At Cannot read property 'any' of undefined

TypeError: Cannot read property 'any' of undefined
    at Object.addJSDocCustomStyles (/packages/jsdoc-preview/lib/index.coffee:87:35)
    at Object.activate (/packages/jsdoc-preview/lib/index.coffee:38:6)
    at Package.module.exports.Package.activateNow (/app.asar/src/package.js:218:19)
    at /app.asar/src/package.js:190:32
    at Package.module.exports.Package.measure (/app.asar/src/package.js:96:15)
    at /app.asar/src/package.js:183:26
    at Package.module.exports.Package.activate (/app.asar/src/package.js:180:34)
    at PackageManager.module.exports.PackageManager.activatePackage (/app.asar/src/package-manager.js:550:34)
    at /app.asar/src/package-manager.js:531:29
    at Config.module.exports.Config.transactAsync (/app.asar/src/config.js:337:18)
    at PackageManager.module.exports.PackageManager.activatePackages (/app.asar/src/package-manager.js:526:19)
    at PackageManager.module.exports.PackageManager.activate (/app.asar/src/package-manager.js:508:46)
    at /app.asar/src/atom-environment.js:812:28

Commands

Non-Core Packages

atom-beautify 0.29.17 
atom-easy-jsdoc 4.10.0 
atom-minify 0.8.0 
autoclose-html 0.23.0 
autoprefixer 3.6.1 
color-picker 2.2.5 
jsdoc-preview 1.2.1 
language-babel 2.55.1 
linter 1.11.23 
linter-eslint 8.1.2 
minimap 4.26.8 
seti-syntax 1.1.2 
seti-ui 1.6.1 
status-bar-clock 2.0.4 

Non functional / dead project

Seems this package is non functional in Atom 1.39.0-beta3 while using .mjs files.
Seeing as the author responded with "no time for this repo" in other issues coupled with last cummit time, we can conclude this project is dead...

Hotkey and Menu do no initiate the JSDoc preview

Hello, I've spent quite some time looking through my editor to make sure I'm not overlooking anything. The issue is that when I either select the plugin from the menu, try the hotkey or even type the command in the the atom command pallette, it never engages the preview. I saw that the package seems to work similarly to the markdown preview package (which I also use). the markdown preview package works well.

I'm willing to tell you whatever you need to know about my setup to help, but I'm not sure where to begin. Here's the important parts can think of right now:

• I am using the latest version of your plugin
• I am using Atom 1.13.0
• I am using atom on windows
• I can see the hotkey is bound to the jsdoc preview in the settings
• when i hit the hotkey, it does the default editor 'duplicate line'
• I attempted to remap the key in the settings to something I was certain there was no other functionality bound to, and I still did not see the preview

I am happy to give you any more details if it will help you troubleshoot.

Is not previewed "No JSDocs to Preview"

Displayed with "No JSDocs to Preview", Is not JSDocs previewed.

lag when the preview is open

I notice significant lag in any editor window when the preview window is open.