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

markdown-vscode-contributions

v1.1.3

Published

Generate markdown tables from vscode contributions

Downloads

8

Readme

Markdown VSCode Contributions

This package allows generating and updating tables in markdown format containing VSCode Contributions data with just a few commands

Installation

Using npm:

npm i --save-dev markdown-vscode-contributions

Usage

updateContributions.js

import { markdownVscodeContributions } from "markdown-vscode-contributions";

markdownVscodeContributions({
  packagePath: "package.json",
  inputPath: "README-raw.md",
  outputPath: "README.md",
});

Parameters:

| Parameter | Description | Default value | | ----------- | ------------------------------------------------------------- | ------------------ | | packagePath | Path to the package file, relative to the current root folder | 'package.json' | | inputPath | Path to the input file, relative to the current root folder | 'README.md' | | outputPath | Path to the output file, relative to the current root folder | inputPath value * |

* by default overwrites the original input file

In your package.json file you should have contributions defined. Example:

{
    "..."
    "contributes": {
        "commands": [
            {
                "command": "color-picker-universal.translateColors",
                "title": "Translate colors to another format",
                "category": "Color Picker Universal"
            }
        ],
    }
}

Then in your markdown file (e.g. README.md) you need a markdown comment with the following format:

[//]: # "vscode-table-contributionName(Column1|Column2:Column2 alias)"

  • The alias of each column is optional
  • Spaces won't be trimmed

SEE SUPPORTED VALUES

Example:

### Commands

[//]: # "vscode-table-commands(title:Name|command)"

After running updateContributions.js you will get the following output:

### Commands

[//]: # "vscode-table-commands(title:Name|command)"

| Name                               | command                                |
| ---------------------------------- | -------------------------------------- |
| Translate colors to another format | color-picker-universal.translateColors |

🌐 Links

NPM

Github Repository