jxxcarlson/markdown-to-scripta/1.0.4

Markdown to Scripta

Convert Markdown syntax to Scripta markup language.

There is only one exported function: convert : String -> String in the module MarkdownToScripta.

Installation

elm install jxxcarlson/markdown-to-scripta

Usage

import MarkdownToScripta

markdown : String
markdown = """
# Hello World

This is **bold** and this is *italic*.

- Item 1
- Item 2

scripta : String
scripta = MarkdownToScripta.convert markdown

-- Result:
-- # Hello World
--
-- This is [b bold] and this is [i italic].
--
-- - Item 1
-- - Item 2

Supported Markdown Features

See the repo if the table below is not rendered properly.

MarkdownScriptaExample
HeadingsSame# Heading → # Heading
Bold[b ...]bold → [b bold]
Italic[i ...]italic → [i italic]
Inline codeSamecode → code
Code blocks(1)THE CODE → (1)
Links[link ...]text → [link text url]
Images[link ...]alt → [link alt url]
Blockquotes(2)> THE QUOTATION → (2)
Tables(3)Pipe table → (3)
Horizontal rule[hrule]--- → [hrule]
ListsSame- item → - item
Numbered List. item2. item → . item
Inline mathSame$x^2$ → $x^2$
Display math(4)$$THE EQUATION$$ → (4)
  Scripta Examples
  
  (1)
  | code
  THE CODE
  
  (2)
  | quotation
  THE QUOTATION
  
  (3)
  | csvtable
  COMMA SEPARATED DATA
  
  | equation
  THE EQUATION

Math Support

Inline Math

Inline math uses single dollar signs with strict whitespace rules:

  • Valid: $x^2$, $E=mc^2$
  • Invalid: $ x^2$ (space after $), $x^2 $ (space before $)

Display Math

Display math uses double dollar signs and converts to equation blocks:

$$
E = mc^2
$$

Becomes:

| equation
E = mc^2

Demo Application

A live demo application is included in the demo/ directory:

cd demo/
sh make.sh

Then open build/index.html in your browser.

License

MIT