Quasar App Extension QMarkdown

The QMarkdown App Extension adds the QMarkdown component to a Quasar CLI Vite application. It registers the boot file, adds the QMarkdown stylesheet, configures Vue template handling for markdown content, and can optionally allow importing raw markdown (*.md) files.

QMarkdown v3.0.0

QMarkdown v3 supports Quasar CLI Vite 3. The app extension requires @quasar/app-vite >=3.0.0 and no longer supports webpack-based Quasar apps. If your application is still using @quasar/app-webpack, migrate the application to Quasar CLI Vite before installing QMarkdown v3.

Install

quasar ext add @quasar/qmarkdown

Requirements

• Quasar v2.
• @quasar/app-vite >=3.0.0.

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

Prompt

During install, QMarkdown asks one setup question:

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

The default answer is true. When enabled, QMarkdown adds a Vite raw importer so your Quasar app can import markdown files as strings:

import markdown from "../examples/myMarkdownFile.md";

You can then pass that string to the QMarkdown component.

Uninstall

quasar ext remove @quasar/qmarkdown

Describe

When installed as an App Extension, you can use:

quasar describe QMarkdown

Documentation

Docs, demos, and examples are hosted at https://qmarkdown.netlify.app/.

Source

The project source is available at https://github.com/quasarframework/quasar-ui-qmarkdown.

Support

If QMarkdown is useful in your workflow and you want to support ongoing maintenance:

• GitHub Sponsors: https://github.com/sponsors/hawkeye64
• PayPal: https://paypal.me/hawkeye64

License

MIT (c) Jeff Galbraith [email protected]