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

easydoc

v0.8.1

Published

A simple technical documentation site with markdown files

Downloads

8

Readme

Welcome to Easydoc !

What's the deal ?

Easydoc is a tiny web server that publish your documentation written in markdown.

It provides you a file index for browsing, and a full-text search.

It's very basic, and very easy to use and customize.

Installation

  1. You'll need the appropriate NodeJs installation on your system.
  2. Download the latest version of easydoc and unzip it
  3. From the command line, build it: > npm install -g
  4. Also from the command line, run it > easydoc

How can I use it ?

Once the server is running, simply drops your documentation files written in markdown and with the 'md' extension in the docs folder.

Let's say your file is named 'myfile.md' With a browser, go to [http://localhost/myfile.md]: that's it !

How do I customize the look&feel ?

For the markup, just edit the two template files inside the _assets folder:

  • page.tpl. It displays a single page with the file index and search box.
  • search.tpl. It shows the search results.

They are using the mustache templating language. Very easy to use.

Fot rendering customizations, all is in the style.css file.

I need to customize the root folder !

When launching the server, you can specify your root folder.

Here is the command line documentation of the server:

Usage: ./easydoc [options]

Options:

    -h, --help            output usage information
    -V, --version         output the version number
    -r, --root [docs]     Absolute or relative path to the root folder containing static and markdown files.
    -p, --port [80]       Local port of the created Http server.
    -h, --host [0.0.0.0]  Hostname of the created Http server.
    --no-cache            Disable mustache template caching (for dev purposes)
    

Are their limitations ?

Yes, plenty ! But i'll enrich it latter ^_^

  • all markdown files at the same level, in the same folder. No sub-folders.
  • assets (page.tpl, search.tpl, style.css, images) must be in the _assets folder inside the document root.
  • no page templating (mustache) in plain html file.
  • markdown files must have the .md extension.

have fun !