Socket
Socket
Sign inDemoInstall

markdown-model

Package Overview
Dependencies
1
Maintainers
1
Versions
77
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

markdown-model

Markdown object model, parser, and renderer


Version published
Maintainers
1
Weekly downloads
15
decreased by-92.75%

Weekly downloads

Readme

Source

markdown-model

npm GitHub

markdown-model API Documentation

markdown-model is a JavaScript Markdown parsing and rendering library.

To parse a Markdown document and produce a Markdown model, use the parseMarkdown function:

import {parseMarkdown} from 'markdown-model/parser.js';

const markdownModel = parseMarkdown(markdownText);

To render the Markdown model in a web browser, use the markdownElements function with the renderElements function from the element-model package:

import {markdownElements} from 'markdown-model/elements.js';
import {renderElements} from 'element-model/elementModel.js';

renderElements(document.body, markdownElements(markdownModel));

You can compute the title of a Markdown document from the Markdown model using the getMarkdownTitle function:

import {getMarkdownTitle} from 'markdown-model/markdownModel.js';

const markdownTitle = getMarkdownTitle(markdownModel);

The validateMarkdownModel function is used to validate Markdown models from untrusted sources or for testing the validity of any code that produces a Markdown model:

import {validateMarkdownModel} from 'markdown-model/markdownModel.js';

validateMarkdownModel(markdownModel);

Development

markdown-model is developed using javascript-build and it was started using javascript-template:

template-specialize javascript-template/template/ markdown-model/ -k package markdown-model -k name 'Craig A. Hobbs' -k email 'craigahobbs@gmail.com' -k github 'craigahobbs' -k noapp 1

Keywords

FAQs

Last updated on 14 May 2022

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc