Git Product home page Git Product logo

markdown-badge-crafter's Introduction

markdown-badge-crafter

Badge (shield) crafter for Markdown pages and links


Sample Query:

http://127.0.0.1:3000/?type=version&user={Your GitHub Username}&path={User or Organization Name}&repo={Repository Name}&branch={Branch Name}

Stable Version Development Version Node.js CI GitHub Issues Discord

Overview

  • markdown-badge-crafter is a minimal badge generator that is written and run in server side NodeJS.

Usage

Package manager

Using npm:

$ npm install markdown-badge-crafter

Using bower:

$ bower install markdown-badge-crafter

Using yarn:

$ yarn add markdown-badge-crafter

Using pnpm:

$ pnpm add markdown-badge-crafter

Once the package is installed, you can import the library using import or require approach:

import markdown-badge-crafter from 'markdown-badge-crafter/app/';

You can also use the default export, since the named export is just a re-export from the markdown-badge-crafter factory:

import markdown-badge-crafter from 'markdown-badge-crafter/app/';

console.log (markdown-badge-crafter .create ('Proper URI'));

If you use require for importing, only default export is available:

const markdown-badge-crafter = require ('markdown-badge-crafter/app/');

Example

import markdown-badge-crafter from 'markdown-badge-crafter';
//const markdown-badge-crafter = require('markdown-badge-crafter'); // legacy way

// Make a request for a user with a given inputs from brouser URI
http .createServer (async (req, res) => {
	const url_obj = new URL (req .url, `http://${req .headers .host}`);
	let response = await router .get (url_obj);

	res .writeHead (response .status, {
		'Content-Type': response .type,
		'Content-Length': response .data .toString() .length,
		'Expires': new Date() .toUTCString()
	});

	res .end (response .data);
}) .listen (config .port, config .host, () => {
	console .log (`Server running at http://${config .host}:${config .port}/`);
});

Note: async/await is part of ECMAScript 2017 and is not supported in Internet Explorer and older browsers, so use with caution.

Showcase

Image


History

  • Hi, this is the inititiator of this repo. After searching in npm registri could not find dynamic version badge for markdown, so creating this, feen free to test, use and contribute.

  • Please try this tool on systems (computer, mobile, embded systems having nodejs running).

๐Ÿ’ Support

If you like this DSA Project and would like to support & appreciate it via donation then I'll gladly accept it.

Ko-Fi Buy Me a Coffee

Patreon Paypal BHIM UPI Google Pay Razor Pay Stripe

markdown-badge-crafter's People

Contributors

sayanshankhari avatar

Forkers

yigitsasmaz

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.