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

min-doc

v1.0.0

Published

hackable simple documentation generation template

Downloads

2

Vulnerabilities

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

Links

Git

Maintainers

chungchi300chungchi300

Keywords

Readme

What is m-doc

m-doc is an hackable simple documentation generation template that support .md=>html and .plantuml=>img tool.

Pretty

  • Easy install - All you need is having node and npm installed
  • Easy editing - All you need is text editor like(nodepad++) to draw different graph and styling.
  • Good verision control - Because plantuml allow Easily create UML Diagrams(Flow chart,Sequence diagram,Class diagram) from simple textual description.
  • Github-like html style - Because when html generated from markdown using the github markdown css
  • hackable - Want to integrate with mindmap?Want to have .mp3 file?Simply Modify the generate.js file and create your own documentation generation tool.

Usage

git clone [email protected]:chungchi300/m-doc.git
npm install
npm run generate
/*
if you want to automatically generate file after editing.
npm run generate-watch
*/

Example

Self

Optional

Despite you can edit using any text editor,there is some plugins and editor suggested to use for real time preview & wysiwyg on single file

Editor

VS Code Studio

Plugins

VS Code Studio