@biblo/addon-simple-markup

Biblo addon simple markup

Biblo addon for parsing simple markup.

Bold text

"Lorem **bold** ipsum" ➡️ Lorem bold ipsum

Italic text

"Lorem _italic_ ipsum" ➡️ Lorem italic ipsum

Strike through text

"Lorem ~~strike through~~ ipsum" ➡️ Lorem strike through ipsum

Installation

# npm
npm install @biblo/addon-simple-markup --save

# Yarn
yarn add @biblo/addon-simple-markup

Initialization

Import the addon and add it to BibloProvider:

import React from "react";
import {
    bibloImporter,
    BibloProvider,
} from "@biblo/react-native";

// Import the addon
import BibloAddonSimpleMarkup from "@biblo/addon-simple-markup";

const components = bibloImporter(
    require.context("/", true, /\.biblo\.[tj]sx?$/),
);

export default function App() {
    return (
        <BibloProvider
            // Apply the addon
            addons={[BibloAddonSimpleMarkup]}
            components={components}
        >
            ...
        </BibloProvider>
    );
}

Options

The default markup is set with

• ** for bold
• _ for italic
• ~~ for strike through

This can be changed by passing an object to BibloAddonSimpleMarkup:

<BibloProvider
    addons={[
        BibloAddonSimpleMarkup({
            bold: "*",
            italic: "__",
            strikeThrough: "--",
        }),
    ]}
    components={components}
>
    ...
</BibloProvider>