markdown-service

markdown-service ·

🚀 Installation

npm install markdown-service

🧐 How to use?

import markdownService from "markdown-service";

const markdown = await markdownService("//domain.com/awesome-readme.md");

⚙️ Format support

Markdown syntax

Front matter ---

YAML can be used at the top of Markdown documents to add more structured data.

Surround the YAML with two lines of consecutive dashes.

---
name: "The shadow of the wind"
author: "Carlos Ruiz Zafón"
---

_Daniel_, welcome to the cemetery of forgotten books.

const markdown = await markdownService("//domain.com/markdown.md");

/*
{
  head: {
    name: "The shadow of the wind",
    author: 'Carlos Ruiz Zafón',
  },
  content: '<strong>Daniel</strong>, welcome to the cemetery of forgotten books.'
}
*/

License

MIT License © Juan Carlos Ruiz