app-extension

Quasar App Extension QMarkdown

The QMarkdown app extension can do the following:

1. Automatically inject the @quasar/quasar-ui-qmarkdown component using the Quasar CLI.
2. Modify webpack to allow importing of markdown (*.md) files.
3. Modify webpack to allow importing of vue+markdown (*.vmd) files.

Remember, app extensions can only be used with the Quasar CLI.

Updating

If you already have the app extension installed, you can use the Quasar CLI to automatically update it via:

quasar upgrade -i

If you are updating from a beta version, to v1.0.0, you will also need to do the following:

quasar ext invoke @quasar/qmarkdown

At which point you will be asked two questions about importing markdown (*.md) and vue+markdown (*.vmd) files.

New Install

quasar ext add @quasar/qmarkdown

Quasar CLI will retrieve it from NPM and install the extension.

Prompts

When installing the QMarkdown app extension, you will be prompted with two questions:

1. "Do you want to be able to import markdown (*.md) files?"

The default is true for the above question. It allows you to do this in your Quasar apps:

import markdown from '../examples/myMarkdownFile.md'

You can now use the QMarkdown component to process the markdown file to be displayed on your page.

2. "Do you want to be able to import vue+markdown (*.vmd) files?"

The default is true for the above question. It allows you to do this in your Quasar apps:

import vmd from '../examples/myVuePlusMarkdownFile.vmd'

components: {
  myComponent: vmd
}

vmd files also allow you to provide front-matter as part of the processing. Be sure to read the documentation to understand how this works.

Uninstall

quasar ext remove @quasar/qmarkdown

Describe

You can use quasar describe QMarkdown for the QMarkdown component

Demo Project (source)

Can be found here.

Documentation

Can be found here.

Live Demo

Can be found here.

Donate

If you appreciate the work that went into this project, please consider donating to Quasar or Jeff.

License

MIT (c) Jeff Galbraith [email protected]