Code Monkey home page Code Monkey logo

bionic-markdown's Introduction

Bionic Markdown

bionic-markdown enabels the manipulation of Markdown files for bionic reading. More specifically, it will parse Markdown into an AST and extract paragraph text nodes. Those text values get changed into bionic text by using text-vide.

Installation

You can add this package to your project using npm or yarn:

npm install bionic-markdown
yarn add bionic-markdown

Usage

import bionicifyMarkdown from "bionic-markdown";

const md = "This is some markdown";

console.log(bionicifyMarkdown(md));
// log: '**Thi**s **i**s **som**e **markdo**wn\n'

Caveats

The functionality of this package is tailored towards its author's needs. As such, any MAST nodes with text values containing any of the elements below will not be converted:

const invalid_element_indicators = {
  table_1: "| -",
  table_2: "|-",
  math: "$",
  footnote: "[^",
};

The two table options account for the differences of formatting tools.

Frontmatter fields are ignored by default.

Contributing

This package is not actively maintained. You are welcome to contribute but active development of this package cannot be guaranteed.

Good first pull requests:

  • Add an option to use the real API endpoint (will require parsing a HAST, convert it to MDAST and serialise it)
  • Migrate to TypeScript

bionic-markdown's People

Contributors

ericjanto avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

Forkers

alextheyounga

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.