https://github.com/greybax/md-tags
Extract tags from your markdown article
https://github.com/greybax/md-tags
article extract-tags markdown markdown-article markdown-it markdown-parser md md-article md-tags mdx post tag tagger tagging taghelpers taglib tags tags-input tagset tagsinput
Last synced: about 1 month ago
JSON representation
Extract tags from your markdown article
- Host: GitHub
- URL: https://github.com/greybax/md-tags
- Owner: greybax
- Created: 2016-02-01T22:10:11.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-11-27T03:57:20.000Z (over 4 years ago)
- Last Synced: 2025-04-12T05:42:18.274Z (about 1 month ago)
- Topics: article, extract-tags, markdown, markdown-article, markdown-it, markdown-parser, md, md-article, md-tags, mdx, post, tag, tagger, tagging, taghelpers, taglib, tags, tags-input, tagset, tagsinput
- Language: JavaScript
- Homepage:
- Size: 58.6 KB
- Stars: 5
- Watchers: 2
- Forks: 14
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# md-tags
[](https://greenkeeper.io/)
[![NPM version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
[![Coveralls Status][coveralls-image]][coveralls-url]
[![Dependency Status][depstat-image]][depstat-url]
[![DevDependency Status][depstat-dev-image]][depstat-dev-url]
[](https://www.patreon.com/bePatron?u=14980891)
> Extract tags from your markdown article
## Install
npm install --save md-tags
## Usage
```js
import mdTags from 'md-tags';
const post1 = `
# Title
_January 30, 2016_
#nodejs, #markdown, #my-tag;`;
const post2 = `
# Title
_January 31, 2016_
#nodejs, #just-tag;`;
const post3 = `
# Title
_February 30, 2016_
#markdown, #my-tag;`;
let tags = mdTags().tagsForPost(post1);
tags.md; // #nodejs, #markdown, #my-tag
tags.text; // nodejs, markdown, my-tag
tags.list; // ["nodejs", "markdown", "my-tag"]
let posts = [];
posts.push(post1,post2,post3);
let postsMatchedByTag = mdTags().postsForTag('my-tag', posts);
/*
[
"# Title
_January 30, 2016_
#nodejs, #markdown, #my-tag"
,
"# Title
_February 30, 2016_
#markdown, #my-tag"
]
*/
```
## API
### tagsForPost(post)
Return object `{md: String, text: String, html: string, list: Array}`.
#### post
*Required*
Type: `String`
Markdown string.
### postsForTag(tag, posts)
Return `list: Array` array of posts in markdown syntax, which matches by tag.
#### tag
*Required*
Type: `String`
Tag for searching in posts.
#### posts
*Required*
Type: `Array`
Array of posts in markdown syntax
## License
MIT © [Aleksandr Filatov](https://alfilatov.com/)
[npm-url]: https://npmjs.org/package/md-tags
[npm-image]: https://img.shields.io/npm/v/md-tags.svg?style=flat-square
[travis-url]: https://travis-ci.org/greybax/md-tags
[travis-image]: https://img.shields.io/travis/greybax/md-tags/master.svg?style=flat-square
[coveralls-url]: https://coveralls.io/r/greybax/md-tags
[coveralls-image]: https://img.shields.io/coveralls/greybax/md-tags/master.svg?style=flat-square
[depstat-url]: https://david-dm.org/greybax/md-tags
[depstat-image]: https://david-dm.org/greybax/md-tags.svg?style=flat-square
[depstat-dev-url]: https://david-dm.org/greybax/md-tags
[depstat-dev-image]: https://david-dm.org/greybax/md-tags/dev-status.svg?style=flat-square