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

hardocs

v1.2.13

Published

Hardocs stand for hardware documentation. It is a template to easily start an open hardware project document it, and publish it using a git based workflow

Downloads

2

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

jurrajurra

Keywords

hardware documentationmarkdownweb template

Readme

Hardocs

Hardocs is a CLI to generate open hardware documentation templates and services.The current version supports documentation in markdown, and a static site generator to show the hardware project in an intuitive way.

Prerequisites

Install node.js Install git to use the gitbash

Usage

Generate a static website easy to maintain with markdown that can be hosted in github or gitlab

Step1: Install package globally

# Install the package globally
npm install hardocs -g

Step2: Create new documentation files within your project

# Generates docs template
docz-generate

Step3: Install packages and dependencies

npm install

Step2: Deploy locally and see your documentation on the browser

npm run start