https://github.com/agoose77/jupyterlab-imarkdown
Embed rich output in Markdown cells.
Science Score: 26.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.4%) to scientific vocabulary
Keywords
Repository
Embed rich output in Markdown cells.
Basic Info
Statistics
- Stars: 17
- Watchers: 6
- Forks: 2
- Open Issues: 8
- Releases: 2
Topics
Metadata Files
README.md
jupyterlab_imarkdown
[!WARNING] This extension is effectively in maintenance mode;
jupyterlab-mystprovides this feature (and more!) under a single extension. Feel free to check it out!
A JupyterLab extension to embed rich output in Markdown cells.
This extension implements only the machinery required to embed rich outputs. Parsing Markdown into expressions is performed with a separate plugin jupyterlab-markup-exp that must be installed:
markdown
The current value of x is {{ x }}
Technical Details
jupyterlab-imarkdown has to do some pretty unpleasant things in order to provide interactive Markdown.
In particular, we implement our own NotebookPanel.ContentFactory in order to inject our own IMarkdownCell.
This custom class implements routines to detect when the Markdown cell has been rendered, keep track of special eval-expr DOM nodes,
and update these DOM nodes with the result of kernel execution.
Requirements
- JupyterLab >= 3.0
jupyterlab-markup-exprfor{{ expr }}parsing (optional)
Install
To install the extension, execute:
bash
pip install jupyterlab_imarkdown
Uninstall
To remove the extension, execute:
bash
pip uninstall jupyterlab_imarkdown
Contributing
Development install
Note: You will need NodeJS to build the extension package.
The jlpm command is JupyterLab's pinned version of
yarn that is installed with JupyterLab. You may use
yarn or npm in lieu of jlpm below.
```bash
Clone the repo to your local environment
Change directory to the jupyterlab_imarkdown directory
Install package in development mode
pip install -e .
Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
Rebuild extension Typescript source after making changes
jlpm run build ```
You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
```bash
Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
Run JupyterLab in another terminal
jupyter lab ```
With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
By default, the jlpm run build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
bash
jupyter lab build --minimize=False
Development uninstall
bash
pip uninstall jupyterlab_imarkdown
In development mode, you will also need to remove the symlink created by jupyter labextension develop
command. To find its location, you can run jupyter labextension list to figure out where the labextensions
folder is located. Then you can remove the symlink named jupyterlab-imarkdown within that folder.
Packaging the extension
See RELEASE
Owner
- Name: Angus Hollands
- Login: agoose77
- Kind: user
- Location: United Kingdom
- Company: 2i2c
- Twitter: agoose77
- Repositories: 230
- Profile: https://github.com/agoose77
Open Source Infrastructure Engineer @ 2i2c. Executable Books core team member. PhD in Nuclear Physics from the University of Birmingham.
GitHub Events
Total
- Watch event: 1
Last Year
- Watch event: 1
Committers
Last synced: over 3 years ago
All Time
- Total Commits: 65
- Total Committers: 2
- Avg Commits per committer: 32.5
- Development Distribution Score (DDS): 0.108
Top Committers
| Name | Commits | |
|---|---|---|
| Angus Hollands | g****5@g****m | 58 |
| Frédéric Collonval | f****l@g****m | 7 |
Issues and Pull Requests
Last synced: 11 months ago
All Time
- Total issues: 15
- Total pull requests: 14
- Average time to close issues: 5 months
- Average time to close pull requests: about 4 hours
- Total issue authors: 5
- Total pull request authors: 2
- Average comments per issue: 1.4
- Average comments per pull request: 1.0
- Merged pull requests: 12
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- agoose77 (11)
- natask (1)
- fcollonval (1)
- ozak (1)
- undefinedMethod (1)
Pull Request Authors
- agoose77 (9)
- fcollonval (5)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 2
-
Total downloads:
- pypi 56 last-month
- npm 11 last-month
-
Total dependent packages: 3
(may contain duplicates) -
Total dependent repositories: 1
(may contain duplicates) - Total versions: 8
- Total maintainers: 1
npmjs.org: @agoose77/jupyterlab-imarkdown
A JupyterLab extension to render expressions given in Markdown.
- Homepage: https://github.com/agoose77/jupyterlab-imarkdown
- License: BSD-3-Clause
-
Latest release: 0.2.0
published about 4 years ago
Rankings
Maintainers (1)
pypi.org: jupyterlab-imarkdown
A JupyterLab extension to render expressions given in Markdown.
- Homepage: https://github.com/agoose77/jupyterlab-imarkdown
- Documentation: https://jupyterlab-imarkdown.readthedocs.io/
- License: BSD-3-Clause
-
Latest release: 0.2.0
published about 4 years ago
Rankings
Maintainers (1)
Dependencies
- @jupyterlab/builder ^3.0.0 development
- @typescript-eslint/eslint-plugin ^4.8.1 development
- @typescript-eslint/parser ^4.8.1 development
- eslint ^7.14.0 development
- eslint-config-prettier ^6.15.0 development
- eslint-plugin-prettier ^3.1.4 development
- npm-run-all ^4.1.5 development
- prettier ^2.1.1 development
- rimraf ^3.0.2 development
- typescript ~4.1.3 development
- @jupyterlab/application ^3.0.0
- @jupyterlab/apputils ^3.0.0
- @jupyterlab/cells ^3.0.0
- @jupyterlab/codeeditor ^3.0.0
- @jupyterlab/notebook ^3.0.0
- @jupyterlab/rendermime ^3.0.0
- @jupyterlab/services ^6.0.0
- @lumino/coreutils ^1.5.3
- @lumino/widgets ^1.17.0
- actions/cache v2 composite
- actions/checkout v2 composite
- actions/download-artifact v2 composite
- actions/setup-node v1 composite
- actions/setup-python v2 composite
- actions/upload-artifact v2 composite
- ipympl
- ipywidgets
- jupyter-packaging
- jupyterlab >=3,<4.0.0a0
- jupyterlab-markup
- matplotlib
- nodejs >=14,<15
- numpy
- pip
- python >=3.8,<3.9.0a0
- sympy
- wheel