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

@bigcommerce/typedoc-plugin-markdown

v1.3.0

Published

A plugin for Typedoc that exposes a theme and additional arguments for rendering markdown.

Downloads

15

Readme

@bigcommerce/typedoc-plugin-markdown

A plugin for TypeDoc that exposes a theme and additional arguments for rendering markdown. This is a forked version of typedoc-plugin-markdown that is modified to suit the needs of BigCommerce.

Installation

npm install --save-dev typedoc @bigcommerce/typedoc-plugin-markdown

Usage

Specify the theme

The plugin provides an additional markdown theme:

shell:

$ node_modules/.bin/typedoc --theme markdown

npm script:

"scripts": {
 "docs": "typedoc --theme markdown"
}

Additional arguments

The plugin exposes the following additional arguments:

  • --mdEngine <github|bitbucket|gitbook>
    The markdown rendering engine:
    "github": Optimised for GitHub/CommonMark (Default).
    "bitbucket": Renders markdown to support Bitbucket anchor linking and more.
    "gitbook": Adds SUMMARY.md file to generate a book's table of contents and sets header levels to display correct sub-navigation menu. (Optimised for newest version of GitBook).

  • --mdHideSources
    Suppress source file linking from output.

  • --mdSourceRepo <path.to.repo>(Will be ignored on GitHub repositories)
    The source repo to use for source file linking.
    For bitbucket use: https://bitbucket.org/owner/repository_name.

Example output

Acknowledgements