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

@dashkite/writeme

v0.2.0

Published

Generate Markdown reference documentation from metadata.

Downloads

15

Readme

WriteMe

Generate Markdown reference documentation from metadata using JavaScript.

import { compile } from "@dashkite/writeme"
import YAML from "js-yaml"

assert /^# Push/.test marked compile YAML.load """
  name: push
  type: function
  description: Push an item onto the stack.
  signatures:
  - arguments:
    - name: stack
			type: Stack
			description: A stack.
    - name: item
      description: The item to push onto the stack.
    returns:
      name: stack
      type: Stack
      description: A new stack with _item_ pushed onto it.
"""

Generates a document that will render to HTML something like this:

Push

Function

push stack, item → stack

| name | type | description | | ------- | ----------- | -------------------------------------- | | stack | [Stack][] | A stack. | | item | any | The item to push onto the stack. | | → stack | [Stack][] | A new stack with item pushed onto it |

Push an item onto the stack.

Links are resolved using an optional index. You can generate an index using index, optionally passing it an index to update.

import { index } from "@dashkite/writeme"
import YAML from "js-yaml"

assert (index name: "foo", "./foo.md")["foo"] == "./foo.md"

Features

  • Functions
  • Classes: coming soon
  • Methods: coming soon

Install

npm i -D @dashkite/writeme

Reference

API

compile

compile yaml → markdown

Compiles the given YAML specification into Markdown.

Schema

Function

Coming soon.

Class

Coming soon.

Method

Coming soon.