https://github.com/antaresvalle/gettinglinksfrommarkdown
Getting links from Markdown it’s a module that receives a string in Markdown format and extracts all the links founded, returning an array of objects.
https://github.com/antaresvalle/gettinglinksfrommarkdown
babel es6-javascript javascript materialize-css mocha-tests node-js npm regex
Last synced: about 1 month ago
JSON representation
Getting links from Markdown it’s a module that receives a string in Markdown format and extracts all the links founded, returning an array of objects.
- Host: GitHub
- URL: https://github.com/antaresvalle/gettinglinksfrommarkdown
- Owner: antaresvalle
- Created: 2018-07-13T19:52:41.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-09-04T20:27:18.000Z (over 7 years ago)
- Last Synced: 2025-03-06T10:09:16.696Z (11 months ago)
- Topics: babel, es6-javascript, javascript, materialize-css, mocha-tests, node-js, npm, regex
- Language: JavaScript
- Homepage: https://antaresvalle.github.io/gettingLinksFromMarkdown/
- Size: 3.02 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Getting links from Markdown
***
Getting links from Markdown it’s a module that receives a string in Markdown format and extracts all the links founded, returning an array of objects.
Visit the test page at [https://antaresvalle.github.io/gettingLinksFromMarkdown/](https://antaresvalle.github.io/gettingLinksFromMarkdown/)
## Usage
Install the next command in the terminal:
```
npm install getting-links-from-markdown
```
Use the following template to implement the package:
```js
const gettingLinksFromMarkdown = require('./dist/gettingLinksFromMarkdown');
const markdownString = `# Lorem ipsum
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
incididunt ut [labore](https://en.wiktionary.org/wiki/labore) et
[dolore](https://en.wiktionary.org/wiki/dolore) magna aliqua. Ut enim ad minim
veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
consequat.
[foo](http://foo.com)
Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu
fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in
culpa qui officia deserunt mollit anim id est laborum.`
const links = gettingLinksFromMarkdown(markdownString);
console.log(links);
// [
// { href: 'https://en.wiktionary.org/wiki/labore', text: 'labore' },
// { href: 'https://en.wiktionary.org/wiki/dolore', text: 'dolore' },
// { href: 'http://foo.com', text: 'foo' },
// ]
```
### Node
Include the following require function:
```
const gettingLinksFromMarkdown = require('./dist/gettingLinksFromMarkdown');
```
### Browser
Include it in your HTML:
```html
```
### NPM package
[https://www.npmjs.com/package/getting-links-from-markdown](https://www.npmjs.com/package/getting-links-from-markdown)
### Authors
Antares Valle & Jesica Domínguez
## Desarrollado para
[Laboratoria](http://laboratoria.la)