← All tasks
pythonjupyterlab/jupyterlab #15139Not a task: not reproduced

Mermaid Usage Instructions Missing

envgap__jupyterlab__jupyterlab-15139

01 / FAILURE SIGNATURE

As reported upstream

No identifying execution failure has been captured.
Not a benchmark task.
  • In a clean container the reported failure did not reproduce, or the known fix did not make the project run.

02 / ENVIRONMENT RECIPE

Base commit
b91e65e59f0a5d7d5a6fdd6d405913a8133ef71e
Manifest
pyproject.toml
Reproduce
Awaiting issue-specific recipe
Run under trace
Awaiting a meaningful runtime command

03 / ORIGINAL ISSUE TEXT

jupyterlab/jupyterlab #15139 · read the original issue
## Description



This is a documentation-only issue, and I've spent some time digging to get to the bottom of this but there is nothing I've been able to find on the web, phind.com, or, importantly, Jupyter Lab's documentation.



1. [Here](https://jupyterlab.readthedocs.io/en/stable/user/extensions.html#id9) is the Installation Instructions for Extensions, they seem incomplete because they don't have an example of the syntax of how to install a plugin. While it may be as simple as pip installing, it's unclear how to treat the @jupyterlab/extension syntax.



2. Additionally, this [PR](https://github.com/jupyterlab/jupyterlab/issues/14788) has been merged and from what I can tell is out however even on the [latest](https://jupyterlab.readthedocs.io/en/latest/search.html?q=mermaid) documentation (as opposed to stable) and mermaid is listed as a core plugin, but without instructions.



It would be great to know some tips and tricks and usage instructions. For example, is this applicable in markdown files and notebook files? Is there a way to make the mermaid diagram source available while viewing a markdown cell. Often with plotting libraries you can see the code that generates the rendered plot. Is there something like that for a markdown cell. Is this also available on jupyter notebook, or just in jupyter lab?



Thank you.
Continue on GitHub ↗

04 / LABELS

Labels from the report text only; not yet run

No supported category has been assigned.

Label rules and the text that matched
[]