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

monstra

v0.9.2

Published

orbit prop table generator

Downloads

1,699

Readme

Orbit-monstra is a simple docs generator from ts declaration files for @kiwicom/orbit-components project

Available commands:

  • docs: creates README.md files in component folder with table of props, subcomponents and description example: monstra docs --path='src/*/'

How to document component:

  • To create basic description add to index.d.ts next comment block: /* DOCS: <your description> */

    example:

    /* DOCS:
    
    # AirportIllustration
    
    To implement AirportIllustration component into your project you'll need to add the import:
    
    import AirportIllustration from "@kiwicom/orbit-components/lib/AirportIllustration";
    
    After adding import into your project you can use it simply like:
    
    <AirportIllustration name="Accommodation" size="small" />
    
    */

    Note: (same with /* FunctionalSpec: */)

  • When you run docs command it creates table with Name and Type like: | Name | Type | Optional | Description | | ---------- | ----------------- | ------- | ----------- | | size | [enum](#enum) | | | | name | Name | | |

    in order to add description and default value, you have to add comment lines in index.d.ts file of component in JSDoc format:

    export interface Props extends Globals, SpaceAfter {
      /** The size of the AirportIllustration */
      /** default: "small" */
      readonly size?: "extraSmall" | "small" | "medium" | "large" | "display";
      readonly name: Name;
      readonly alt?: string;
    }