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

gulp-marked-vega

v1.0.1

Published

Gulp plugin to transform marked-vega markdowns in your markdown documents into embedded images so that all standard markdown renderer can still render your charts.

Downloads

2

Readme

gulp-marked-vega Build Status Coverage Status styled with prettier

gulp plugin to replace marked-vega codeblocks with base64 image markdown tags so that any markdown parser can render the Vega or Vega-Lite charts as images.

Currently, only the marked-vega codebase markdown is supported. The image markdown is not supported yet.

API documentation can be found at https://e2fyi.github.io/gulp-marked-vega.

Installation

Yarn

yarn add gulp-marked-vega -D

Npm

npm install gulp-marked-vega -D

Usage

Gulp

Replacing marked-vega codeblocks with image. Export as markdown.

const gulp = require('gulp');
const marked_vega = require('gulp-marked-vega');

gulp
  .src('./test/sample.md')
  .pipe(marked_vega()) // replace codeblocks with image
  .pipe(gulp.dest('test/output')); // output as "test/output/sample.md"

Replacing marked-vega codeblocks with image. Export as HTML. Auto rename to <original_filename>.html.

const gulp = require('gulp');
const marked_vega = require('gulp-marked-vega');

gulp
  .src('./test/sample.md')
  .pipe(marked_vega(true)) // replace codeblocks with image and export as html
  .pipe(gulp.dest('test/output')); // output as "test/output/sample.html"

More details on how to use Gulp as part of your build chain can be found at their site.

Cli

There is also a cli to directly embed the Vega and Vega-Lite charts in your markdown file.

usage: mdvg.js [-h] [-v] -f FILE [-o OUTPUT] [--html]

cli to replace marked-vega codeblocks with base64 embedded charts.

Optional arguments:
  -h, --help            Show this help message and exit.
  -v, --version         Show program's version number and exit.
  -f FILE, --file FILE  Input markdown file to process
  -o OUTPUT, --output OUTPUT
                        Output file to write to
  --html                Convert to HTML

Embed chart only.

mdvg -f ./test/sample.md -o ./test/sample_.md

Embed and convert to HTML.

mdvg -f ./test/sample.md -o ./test/sample_.md --html

marked-vega custom Markdown Syntax

marked-vega introduces a few new markdown syntax.

1. Image markdown

Syntax

![vg|vega|vega-lite|vl](https://someurl/spec.json)

Example

![vega](barchart-vg.json)

2. Code markdown

Syntax

```vg|vega|vega-lite|vl
<Vega/Vega-Lite JSON specification>
or
<Vega/Vega-Lite JSON specification in YAML format>
```

Example - JSON specification

```vega-lite
{
  "data": {
    "values": [
      {"a": "A","b": 28}, {"a": "B","b": 55}, {"a": "C","b": 43},
      {"a": "D","b": 91}, {"a": "E","b": 81}, {"a": "F","b": 53},
      {"a": "G","b": 19}, {"a": "H","b": 87}, {"a": "I","b": 52}
    ]
  },
  "mark": "bar",
  "encoding": {
    "x": {"field": "a", "type": "ordinal"},
    "y": {"field": "b", "type": "quantitative"}
  }
}
```

Example - YAML specification

```vega-lite
data:
  values:
    - x: A
      y: 13
    - x: B
      y: 55
    - x: C
      y: 43
    - x: D
      y: 91      
    - x: E
      y: 81      
    - x: F
      y: 53      
    - x: G
      y: 19      
    - x: H
      y: 87      
    - x: I
      y: 52      
mark:
  bar
encoding:
  x:
    field: x
    type: ordinal
  y:
    field: y
    type: quantitative
```

Development

Compile and publish documentation to /docs.

npm run publish

Lint and Unit testing

npm test

Run demo

npm run demo

Resources