Skip to content

pmqueiroz/ease-mark

Repository files navigation

import-holmes

this project is result of hell boredom coupled with a desire to code a little; I know it's non-sense at all

Instalation

Create a file in the root named .npmrc containing this config:

@pmqueiroz:registry=https://npm.pkg.github.com 

And then run install:

npm install @pmqueiroz/ease-mark
yarn add @pmqueiroz/ease-mark
pnpm add @pmqueiroz/ease-mark

Api Reference

Parse

Parse a string source ease-mark

import { parse } from '@pmqueiroz/ease-mark'

parse('.: Hello word') // <h3>Hello World<h3/>

Using as tagged template function

import { parse } from '@pmqueiroz/ease-mark'

const hello = (name: string) => 'Hello ' + name

parse`.: ${() => hello('World')}` // <h3>Hello World<h3/>

Syntax

Headings

Ease HTML Rendered Output
. Heading level 1 <h1>Heading level 1</h1>

Heading level 1

: Heading level 2 <h2>Heading level 2</h2>

Heading level 2

.: Heading level 3 <h3>Heading level 3</h3>

Heading level 3

:: Heading level 4 <h4>Heading level 4</h4>

Heading level 4

.:: Heading level 5 <h5>Heading level 5</h5>
Heading level 5
::: Heading level 6 <h6>Heading level 6</h6>
Heading level 6

Paragraphs

To create paragraphs, use a blank line to separate one or more lines of text.

Ease HTML Rendered Output
This is a paragraph <p>This is a paragraph</p>

This is a paragraph

Code

Inline

not implemented yet.

Fenced

To create a code block, use three backticks (```) before and after the code. Add the language after the first set of backticks for proper syntax highlighting. Example:

    ```js
          const hello = 'Hello World'
    ```

The rendered output looks like this:

   const hello = 'Hello World'

Made by Peam