Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rishichawda/markdown-magic-build-badge
:confetti_ball: A plugin to update your branch badges to point to correct branch status. You can use it in a script or as a git hook or directly from the command line itself!
https://github.com/rishichawda/markdown-magic-build-badge
badges circleci codecov markdown markdown-magic travis-ci
Last synced: 21 days ago
JSON representation
:confetti_ball: A plugin to update your branch badges to point to correct branch status. You can use it in a script or as a git hook or directly from the command line itself!
- Host: GitHub
- URL: https://github.com/rishichawda/markdown-magic-build-badge
- Owner: rishichawda
- License: mit
- Created: 2018-11-02T13:54:27.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-06T18:55:51.000Z (almost 2 years ago)
- Last Synced: 2024-10-14T20:29:08.424Z (about 1 month ago)
- Topics: badges, circleci, codecov, markdown, markdown-magic, travis-ci
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/markdown-magic-branch-badge
- Size: 797 KB
- Stars: 7
- Watchers: 1
- Forks: 3
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/markdown-magic-branch-badge)
[](https://www.npmjs.com/package/markdown-magic-branch-badge)
[](https://github.com/rishichawda/markdown-magic-build-badge)
[](https://www.npmjs.com/package/markdown-magic-branch-badge)
## markdown-magic-branch-badge
:star2: A plugin to update your branch badges to point to correct branch status via [markdown-magic](https://github.com/DavidWells/markdown-magic).
Supports all major vendors like [TravisCI](http://travis-ci.org/), [Codecov](https://codecov.io/), [CircleCI](https://circleci.com/) and many more that provide code repository status images and badges for readme files. :tada:
---
### Installation :
```
npm i markdown-magic markdown-magic-branch-badge --save-dev
```
### Usage :
Create a file `update-readme.js` in your project directory.
```
const path = require('path');
const transformMarkdown = require('markdown-magic');
const badgePlugin = require('markdown-magic-branch-badge');
const config = {
transforms: {
badgePlugin,
},
};
function callback() {
console.log('ReadME generated.');
}
const markdownPath = path.join(__dirname, 'README.md');
transformMarkdown(markdownPath, config, callback);
```
Create a file, `example-template` with your template.
```
[](https://travis-ci.org/user/repo)
[](https://some_badge_url.com/user/repo)
```
You can use your custom placeholders through `placeholder` parameter. For the complete list of parameters, see [here](#config-options).
If there is no `placeholder` parameter specified in your `README.md` file, the plugin will look for the default placeholder, i.e., `current_branch`.
**NOTE:** Placeholders must be wrapped in curly braces inside the template.
On your `README.md` add the following lines :
```
```
This indicates the plugin to add the badges between these comments in your readme file.
If you are using your own placeholder, you can specify it like this :
```
```
Now, go to the terminal and run:
```
markdown-badge -u ./update-readme.js
```
After running this command, now you should see the updated `README.md` with the badges according to your branch name.
---
### Config options
| Option | Description |
| ------------- | ------------- |
| src | Relative path to the template file. ( **Required** ) |
| addNewLine | Specify whether to add a new line at the end of the written output. By default, it is set to `false`. |
| placeholder | Specify a custom placeholder for updating branch names. |
---
##### Usage options:
Use it in `pre-commit` and `post-checkout` hooks to keep your branches updated with the correct badge URLs.
To add a post-checkout hook via command-line, run `markdown-badge -g` in your project root and it will add it to the post-checkout hook to your repository.
If you have any queries or requests, feel free to open an issue [here](https://github.com/rishichawda/markdown-magic-build-badge/issues) or open a pull request if you want to contribute!