https://github.com/hypercubed/system-md-marked
jspm Markdown plugin (using marked)
https://github.com/hypercubed/system-md-marked
Last synced: over 1 year ago
JSON representation
jspm Markdown plugin (using marked)
- Host: GitHub
- URL: https://github.com/hypercubed/system-md-marked
- Owner: Hypercubed
- License: mit
- Created: 2016-08-23T03:03:18.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-08-23T05:06:34.000Z (almost 10 years ago)
- Last Synced: 2025-02-04T15:25:20.636Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 9.77 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
system-md-marked
=========
Markdown loader for SystemJS using [marked](https://github.com/chjj/marked).
# Overview
A plugin for [SystemJS](https://github.com/systemjs/systemjs) which enables you to import markdown files directly. The files are compiled in the browser to HTML using [marked](https://github.com/chjj/marked).
# Installation
For installing with JSPM run:
```sh
jspm install md=github:Hypercubed/system-md-marked
```
# Basic Use
```js
import readmeHTML from './readme.md!'
```
# Configuration
[Marked configuration options](https://github.com/chjj/marked#options-1) are passed via "mdOptions".
## Either: use the meta tag
```js
System.config({
meta: {
'*.md': {
loader: './md.js',
mdOptions: {
'tables': true
}
}
}
});
```
## Or: using packages configuration
```js
System.config({
packages: {
'src': {
meta: {
"*.md": {
loader: './md.js',
mdOptions: {
tables: true
}
}
}
}
}
});
```
# Acknowledgements
This code is based on [guybedford/system-md](https://github.com/guybedford/system-md).
# License
MIT