wdr-beam
TypeScript icon, indicating that this package has built-in type declarations

0.2.0 • Public • Published

wdr-beam (Web DevRel Beam)

Are you creating content for developer.chrome.com or web.dev? Then this package may be for you!

Instead of running to the web based uploader tool for every file you want to add an image, this tool can easily upload all your images after you're done writing your post.


Installation

npm i -g wdr-beam

Usage

Just inlucde your image in the same folder as the post you're working on, and include it in your post as a Markdown image or an HTML Image tag:

![This dog's name is Jerry!](./jerry.jpg)

...

<img class="w-screenshot" src="./screenshot.png" alt="This is a screenshot">

Then in that folder run the command:

wdr-beam

This library will find all the images in your markdown, upload them to the CDN, delete them locally, and update your posts markdown to use the Img shortcode. What you'll get is this:

{% Img src="image/kSLjHjkFgscBC2j2d6j9/jU9Od9IDqFlmuYzAtirn.jpg", alt="This dog's name is Jerry!" %}

...

{% Img src="image/kSLjHjkFgscBC2j2d6j9/jU9Od9IDqFlmuYzAtirn.jpg", alt="This is a screenshot", class="w-screenshot" %}

Options

The library requires an auth token and a domain, which it will prompt for, or you can provide them as additional arguments when you run the library.

Option Description
-V, --version output the version number
-F, --filepath <string> directory to search in (defaults to current directory)
-T, --token <string> auth token, you can generate one at https://web-dev-uploads.web.app/cli)
-h, --help display help for command

WARNING

This library isn't perfect though... It won't catch all images (like if your image is not in the same folder as the markdown file). Also if it finds an image in a codeblock that is an actual image in the folder, well, it will update it.

Look over the changes this library makes and undo the changes it shouldn't have!

Readme

Keywords

none

Package Sidebar

Install

npm i wdr-beam

Weekly Downloads

1

Version

0.2.0

License

MIT

Unpacked Size

167 kB

Total Files

29

Last publish

Collaborators

  • michaelsolati