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

yuidoc-mdeditor-theme

v1.5.0

Published

YUIDoc theme for mdEditor, forked from yuidoc-ember-theme

Downloads

12

Readme

YUIDoc mdEditor Theme

npm version

An EmberJS based YUIDoc theme

Live Example

$ npm install yuidoc-mdeditor-theme

Notes

Extensions to the YUIDoc Features

Computed properties

Use @category computed and @required

/**
* A computed value
*
* @property something
* @type {Object}
* @category computed
* @required foo,bar
*/   

Class names with slashes

Use -- to represent /:

/**
* @class md-indicator--related
* @extend md-indicator
*/ 

Configuration File

If your project uses a "yuidoc.json" file for configuration, add:

"themedir" : "node_modules/yuidoc-ember-theme",
"helpers" : ["node_modules/yuidoc-ember-theme/helpers/helpers.js"]

Example:

{
    "name": "Example",
    "url": "<GITHUB REPO URL>",
    "version": "0.1.0",
    "indexModule": "Welcome",
    "externalDocs": [{
        "name": "ember-validators",
        "path": "node_modules/ember-validators",
        "url": "https://github.com/offirgolan/ember-validators",
        "version": "master"
    }],
    "options": {
        "paths": "_location to parse_",
        "outdir": "build/docs",
        "exclude": "lib,docs,build",
        "themedir": "node_modules/yuidoc-ember-theme",
        "helpers": ["node_modules/yuidoc-ember-theme/helpers/helpers.js"]
    }
}

Index Module

If indexModule is speficied in your yuidoc.json, the page will be forwarded to that module when a user loads the index page.

{
    "indexModule": "Welcome"
}

External Docs

If you have external documentation taken from dependencies, you may list them under the externalDocs option in your yuidoc.json. Doing so will setup the correct file names and paths.

{
    "externalDocs": [{
        "name": "ember-validators",
        "path": "node_modules/ember-validators",
        "url": "https://github.com/offirgolan/ember-validators",
        "version": "master"
    }]
}