Pkg
Stats

npm package discovery and stats viewer.

Discover Tips

General search
[free text search, go nuts!]
Package details
pkg:[package-name]
User packages
@[username]

Sponsor

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.

Twitter
@PkgStats
GitHub
pkgstats
Twitter
@ryanhefner
GitHub
ryanhefner
Site
ryanhefner.com

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 🙏

Framework
react / react-dom
Server
next / express / next-routes
Data Store
redux / react-redux / next-redux-wrapper / redux-thunk / redux-logger
Caching
lru-cache
CSS / Styling
next-page-transitions / styled-components
Typeface
@ibm/plex
Avatars
gravatar
Data Viz
chart.js / react-sparklines
Date formatting
dayjs
Infinite scrolling
react-scroll-trigger
Markdown rendering
react-markdown
Repository url parsing
hosted-git-info
User data
npm-user
Compiling
babel-plugin-module-resolver / babel-plugin-styled-components
Types
prop-types
Odds & Ends
es6-promise / isomorphic-fetch

© 2024 – Pkg Stats / Ryan Hefner

jsdoc-githubify

v0.1.3

Published

2 years ago

A transform that adapts html files generated with jsdoc to be rendered in a github wiki or readme.

Downloads

44

0High
0Medium
0Low

jsdoc transform github readme wiki html markdown mutiny

jsdoc-githubify

A transform that adapts html files generated with jsdoc to be rendered in a github wiki or readme.

As part of that it converts all source code indicators to point to the relevant file inside your github repository.

Installation

npm install jsdoc-githubify

How do I use this?

This transform is compatible with the following tools:

wicked is using this transform to adapt html files generated by jsdoc in order to generate API wiki pages for your project.

It uses mutiny to run the transform.

API

gitifyTransform(file)

Transforms the piped jsdoc generated html to make it usable on github, i.e. in a Readme or wiki

The resulting html has the following transformations:

all code sample links are redirected point to gihub repo blob
wrap in div.jsdoc-githubify for styling

Note:

The github blob url is derived from the remote of the github repository in the current directory and the currently checked out branch is used. You can override these with the following environment vars:

JSDOC_GITHUBIFY_REMOTE
JSDOC_GITHUBIFY_BRANCH

@name gitifyTransform @function params:

file String filename ignored by this transform

returns:

TransformStream into which to pipe the html string generated by jsdoc

License

MIT