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

@signalwire/typedoc-readme-api-theme

v0.7.1

Published

An extension of typedoc-plugin-markdown to create a compatible file structure for Readme API pages.

Downloads

14

Vulnerabilities

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

Links

Maintainers

bryanritebryanritejpsantosbhzjpsantosbhziammaransariiammaransarilittorwiredlittorwiredstartledmarmotstartledmarmotdanieledsdanieleds

Keywords

markdowntypescriptdocumentationapitypedocplugintypedocreadme

Readme

typedoc-plugin-markdown

A plugin for TypeDoc that renders TypeScript API documentation as Markdown.

npm Build Status

What it does?

The plugin replaces the default HTML theme with a built-in Markdown theme and exposes some additional options.

Useful if documentation is required to be included in project README files, Wikis and static site generators.

Installation

npm install --save-dev typedoc typedoc-plugin-markdown

Usage

Usage is the same as documented at TypeDoc.

typedoc --out docs src/index.ts

Note:

  • If using with the default HTML theme or other themes, use --plugin none to switch the plugin off.
  • The plugin should be executed in the same location as TypeDoc. Use npx if running command directly in shell.

Options

The following options can be used in addition to relevant TypeDoc options.

  • --entryDocument<string> The file name of the entry document. Defaults to README.md.
  • --hideBreadcrumbs<boolean> Do not render breadcrumbs in template header. Defaults to false.
  • --hideInPageTOC<boolean> Do not render in-page table of contents items. Defaults to false.
  • --publicPath<string> Specify the base path for all urls. If undefined urls will be relative. Defaults to ..
  • --namedAnchors<boolean> Use HTML named anchors tags for implementations that do not assign header ids. Defaults to false.

License

MIT