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

tinydoc

v5.0.1

Published

Fast and sleek and modular documentation generator.

Downloads

31

Readme

tinydoc

Build Status Coverage Status

tinydoc is a documentation generator that is able to scan, parse, and present documentation found in different sources in a coherent UI. Example sources are JavaScript modules, Markdown articles, and Rails APIs.

Motivation

  • Write anywhere: docs may live inside the main codebase (right next to your code) or outside; the tool shouldn't care. This caters for people who don't like to look up documentation online and would rather find everything in their code editor, and for others who either do not have the code base, or prefer reading in a browser.
  • Aggregate, linkable docs: the ability to inter-link entities regardless of the source; like pointing to a JavaScript module from a markdown article.
  • Easy deployment: an .html file that requires no webserver to power, so that one can easily host the docs anywhere (like on GitHub Pages or any static server.)

Installation

tinydoc requires Node.js to run and you can get it through NPM by running:

npm install -g tinydoc

Now run tinydoc --help for more information.

Configuration

tinydoc will look for a file called tinydoc.conf.js in the CWD, or use the file specified using the --config command-line argument. The file is a regular JavaScript module. For example:

module.exports = {
    outputDir: "./public/doc"
};

For the actual configuration parameters, please refer to each plugin's README file found under plugins/.

API Docs

You can find them here: http://tinydoc.netlify.com/.

Extending

tinydoc accepts plugins that can hook into the compilation of the docs. The compilation is composed of several phases:

  1. the scanning phase: sources are scraped and a database is generated
  2. the indexing phase: a registry of all linkable entities is generated
  3. the rendering phase: all non-HTML content is converted to HTML and links are resolved
  4. the writing phase: the database, now containing rendered content, is exported to some file which the UI can use to render its stuff

The UI of tinydoc is written in React and is also extensible through different means: outlets and full-fledged plugins.

TODO: UI plugin guide.

Hacking

  • official packages live under /packages

UI tests

npm run test:ui
npm run test:ui:packages

License

Copyright (C) 2015 Ahmad Amireh

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.