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-yuidoc

v0.9.1

Published

Generate documentation of your app/addon from your yuidoc comments

Downloads

3,189

Readme

Ember-cli-yuidoc

This is an ember-cli addon for generate html documentation from YUIDoc comments in the source code.

Installation

If you're using ember-cli > 0.1.5, you can just run ember install ember-cli-yuidoc and you're done.

If you are using an older version, first install the addon from npm with npm install --save-dev ember-cli-yuidoc.

Then, you need to add a yuidoc.json manifest on the root of your project. Run ember g ember-cli-yuidoc to generate once with some sensible defaults.

Usage

As an ember command

This addon adds a new ember-cli-yuidoc command to ember-cli to generate the documentation on demand.

Just run ember ember-cli-yuidoc and your docs will apear in your output directory (/docs by default). You probably want to add this folder to the .gitignore.

Watch mode

This plugin also integrates with the ember server, so you can access your docs from the browser in the /docs urls. The documentation will update when you modify your code, as expected.

While this is specially useful if your are editing your documentation, it adds some overhead to your build pipeline, so this is disabled by default. Run ember serve --docs to enable it.

Environment specific generation

This plugin supports the ability to force generate your documentation via the enabledEnvironments option that may be defined in your yuidoc.json.

{
  "name": "sample-app",
  "version": "1.2.3",
  "options": {
    "enabledEnvironments": ["development", "production"]
  }
}

This will generate your documentation when using ember build ember build --environment=production ember s and so on without needing to use --docs.

Like coffescript? It's ok.

The plugin supports coffescript out of the box. In your application's yuidoc.json you can configure the syntaxtype and extension like this:

{
  "name": "sample-app",
  "version": "1.2.3",
  "options": {
    "paths": ["app"],
    "exclude": "vendor",
    "outdir": "docs",
    "syntaxtype": "coffee",
    "extension": ".coffee"
  }
}