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

marked-tree

v0.8.1

Published

development markdown viewer

Downloads

2

Readme

This is a markdown viewer for viewing markdown within a development environment.

A simple Single page app that is designed to make it simple to view markdown documentation within a project.

It is designed for well documented projects using many linked markdown files to document portions of the application. As long as all markdown files are linked with the main README.md, the markdown-viewer will find all linked markdown files and create a sidebar menu structure to mirror the directory stucture where linked documents appear.

Usage

Install: Run npm install marked-tree

Integrate:

The easiest way to integrate marked-tree into your project is to start it from the root of your project (assuming you have a README.md file at the root.) Running it is as simple as adding a new npm script to your package.json like: "document": "node node_modules/marked-tree/index.js". You can then execute via npm run-script document. This will run the server that will build your markdown documentation tree.

Changelog

Class Documentation