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

@urpflanze/typedoc-docs

v0.1.15

Published

Generate docs site (or references) for typescript project

Downloads

28

Readme

Typedoc-Docs

Motivations

This package comes from the need to generate documentation from a typescript project by applying a custom style.

As a first step I felt the need to simplify the file generated by the command

typedoc. --json <path/to/out-file.json>

In order to have a more readable result and therefore easier to manage.

The style is still tied to urpflanze, but it could become an isolated package.

Installation

Install with npm

npm i -D @urpflanze/typedoc-docs

add generate-docs in your package.json

"scripts": {
    "generate-docs": "npx generate-docs"
}

Testing

After the generation you will have to change the value of the base tag if you want to test it locally

file docs/index.html change

<base href="/.../" />

to

<base href="/" />

and run server in docs dir (for example: php -S localhost:8080)