2.0.0 • Published 2 years ago

@oklookat/jmarkd v2.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

jmarkd

screenshot

Features

  • Toolbar with API
  • Dark/light themes
  • Preview (you need to provide markdown parser)
  • Hmm. What else is needed?

Requirements

  • Modern browser

Example

npm install @oklookat/jmarkd

<div class="container"></div>
import jmarkd from '@oklookat/jmarkd'
import '@oklookat/jmarkd/styles'
import { Config } from '@oklookat/jmarkd'

const container = document.getElementsByClassName('container')[0]

const config: Config = {
    container: container,

    // (optional) preview tool config to display parsed markdown
    toolbar: {
        elements: {
            config: {
                preview: {
                    parse: (data) => {
                        return anotherMarkdownParser.parse(data)
                    }
                }
            }
        }
    }
}

const editor = new jmarkd(config)

Creating you own toolbar item

import jmarkd from '@oklookat/jmarkd'
import '@oklookat/jmarkd/styles'
import { Config, ToolbarElement } from '@oklookat/jmarkd'

class Say implements ToolbarElement {
    private what: string

    get icon() {
        return "Say"
    }

    setConfig(what: string) {
        this.what = what
    }

    getShortcut() {
        return ['AltLeft', 'KeyE']
    }

    onClick(textarea: HTMLTextAreaElement) {
        textarea.value += this.what
    }
}

const container = document.getElementsByClassName('container')[0]
const config: Config = {
    container: container,
    toolbar: {
        // displayed: ['say'] // if you need leave only your items or change item order
        elements: {
            boot: {
                say: new Say()
            },
            config: {
                say: '🌹'
            }
        }
    }
}

const editor = new jmarkd(config)

Types, configs, toolbars, etc

2.0.0

2 years ago

1.0.7

2 years ago

1.0.6

2 years ago

1.0.5

2 years ago

1.0.4

2 years ago

1.0.3

2 years ago

1.0.2

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago