Enable and document how to render MyST as part of other applications or as a standalone component

[choldgraf]

As part of the frx-challenges project, we wanted a way for data challenge administrators to write MyST Markdown for basic formatting of pages served via a Django app. We wanted a way of quickly rendering MyST and output nice HTML, but without the full-blown MyST document engine provided via the CLI.

However, we couldn't figure out how to do this easily. It would be helpful if this were more clearly documented, or enabled if it isn't possible.

Examples for inspiration

For example, we wanted something similar to how JupyterLab-MyST renders "snippets" of MyST markdown with basic MyST functionality, but not everything).

Another workflow we wanted was something similar to markdown-it. In that case, you can render HTML from markdown-it markdown like so:

import markdownit from 'markdown-it'
const md = markdownit()
const result = md.render('# markdown-it rulezz!');

[yuvipanda]

The sample snippet covers what i'd have liked pretty well! Take string of markdown (+ possible options), return HTML