@wq/markdown

2.0.0 • Public • Published

@wq/markdown

@wq/markdown is a @wq/app plugin that adds Markdown and syntax highlighting capabilities to the renderer.

Installation

npm install @wq/markdown

Note: As of version 2.0, @wq/markdown is only compatible with the @wq/material renderer. To integrate with the classic @wq/jquery-mobile renderer, install @wq/markdown 1.x.

API

By default, @wq/markdown looks for a markdown property on the current context. If present, the included view overrides will render the Markdown with react-markdown and react-syntax-highlighter. @wq/markdown specifies @wq/material-based renderers like <Typography/> for the main block types, and automatically distinguishes between internal @wq/router-handled <Link/>s and external <a href/>s. @wq/markdown can be configured to look for a different input context variable, or the exported <Markdown/> component can be used in a custom view.

Usage

// src/index.js
import app from '@wq/app';
import markdown from '@wq/markdown';
import config from './config';

// In src/config.js:
// config.markdown = {'input': 'markdown' };

app.use(markdown);
app.init(config).then(...);

@wq/markdown includes the react-markdown highlight.js parsers for Bash, JavaScript, Python, and XML.

Readme

Keywords

Package Sidebar

Install

npm i @wq/markdown

Weekly Downloads

57

Version

2.0.0

License

MIT

Unpacked Size

1.47 MB

Total Files

21

Last publish

Collaborators

  • sheppard