npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ember-cli-jsdoc

v3.0.0

Published

Generate documentation of your app/addon from your JSDoc comments

Downloads

1,442

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

notmessengernotmessenger

Keywords

ember-addonjsdocdocumentationcommentsdocblock

Readme

Latest Release Ember CLI version License Downloads

Dependencies Dev Dependencies

ember-cli-jsdoc

An Ember CLI addon to generate HTML documentation from JSDoc comments in the source code.

Install

ember install ember-cli-jsdoc

Use

Run ember ember-cli-jsdoc anytime you wish to generate the documentation. You can then access this generated documentation at http://localhost:4200/docs.

Features

  • Smartly generates jsdoc.json configuration file based on your application or addon's setup
    • You can make any changes to this file as needed to suit your configuration needs
  • Generated documentation is accessible at http://localhost:4200/docs
  • Customized JSDoc template to support display of custom @observes tag
  • Automatically populates @listens tag values through use of the emberListensTag plugin
  • You do not have to employ the @default tag for non-complex types, through the use of the defaultTag plugin

Things to know

  • For the best experience using JSDoc comments you should follow this styleguide.
    • This is because JSDoc does not yet currently fully support ES6 syntax nor does its conventions always reflect the architecture of an Ember application.
  • You may wish to add an entry in your .gitignore file for the /docs folder.
  • If you are using a Node version below 5.x.x you will want to change the plugins entry in the jsdoc.json file to the following:
"plugins": [
    "plugins/markdown",
    "node_modules/ember-cli-jsdoc/node_modules/jsdoc-plugins/plugins/defaultTag",
    "node_modules/ember-cli-jsdoc/node_modules/jsdoc-plugins/plugins/emberListensTag",
    "node_modules/ember-cli-jsdoc/node_modules/jsdoc-plugins/plugins/emberObservesTag"
]

Versioning

Employs Semantic Versioning 2.0.0

Contribution

See CONTRIBUTING.md

Copyright and License

ember-cli-jsdoc and its source files are Copyright © 2015-2018 SoftLayer Technologies, Inc. The software is MIT Licensed

Warranty

This software is provided “as is” and without any express or implied warranties, including, without limitation, the implied warranties of merchantability and fitness for a particular purpose.