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

hierdoc

v0.0.1

Published

Simple hierarchical document (eg for technical spec)

Downloads

2

Readme

hierdoc - a simple document construction api

NPM version

Status: mostly works for me. Definitely not stable or "production quality"

We view a document as a tree of sections (and a section itself). Each section has a title and a .html with its own content. The tree is formed by the .children array in each section. This code manages an outer template, a table of contents, section headings (h1, h2, ...), and more for each section. The .html content is included after the section heading and before and child section headings and content.

So this code:

const Doc = require('..')
const w3cStyle = require('../w3cHTML')

const d = new Doc(w3cStyle)
d.title = 'Hello, World!'
d.section('Greetings').html = '<p><i>Hello</i>, World</p>'
d.writeTo('hello.html')

Generates a W3C spec with this body:



In practice, for W3C style, you need to set some other fields, for all the heading information. Right now this document style handles a VERY small class of status and document features, because that's all I need.

Why? Because sometimes, even though you totally respec the bikeshed you've got, you want another one.

More seriously, it's because I'm programmatically generating the content and sometimes modifying it in place. I should probably just figure out how to get respec to handle that, but ... that's not what I did. It was fun.

This runs either in a node command-line environement, generating a static html file, or in the browser, loading/updating content. See example/nest.js for doing both; turn it into static/bundle.js with

$ watchify -o static/bundle.js example/nest.js

then load static/w3c.html to see it rendered.