Markdown*Palettes
Markdown*Palettes is an open-source Markdown editor for the modern web.
Usage
We have four bundle schemes. Choose what you prefer. Note that to use Markdown*Palettes, your web page must be in standard mode and use UTF-8 encoding. e.g.:
With Build Tools (webpack, rollup, etc)
First install our npm package:
$ yarn add markdown-palettes
Since Markdown*Palettes is a Vue component, we assume you're familiar with Vue.
Use the ES6 Module
If you use webpack v2+ or rollup, you can use the ES6 module:
Note that the ES6 module didn't resolve its dependencies and pack them inside. It doesn't matter if you configure your webpack or rollup to resolve into node_modules
, which is the common practice. As a fallback, you can use the CommonJS module.
Use the CommonJS Module
Replacing the ES6 'import' statement with CommonJS 'require' function:
const MarkdownPalettes =
The CommonJS module resolved its dependencies and packed them inside.
Without Build Tools (use directly in HTML)
It's OK to use Markdown*Palettes without build tools, if you're not so familiar with Vue and Node.js toolchain.
Copy the items in dist
directory into your project.
Use with Vue
This is recommended if you use other Vue components in your HTML page.
Use without Vue
This is suitable if you don't have other Vue components in your HTML page or you 'dislike' Vue. Note that this bundle includes Vue inside so it's larger.
External Resources
By default bundle don't contain syntax highlighting for programming languages. If you use the bundles other than ES6 module, unfortunately you have to build it by yourself to get extra language support. If you use ES6 module, you can easily import them:
// register languages for hljshljs // register languages for CodeMirror
Documentation
TODO
Development
First checkout this repo.
$ yarn # install dependencies$ yarn dev # start dev server$ yarn build # build dist
Release
Please upload dist
directory to npm together.
Credits
Developed by @darkflames and @lin_toto of the Luogu Dev Team