jupyterlab-github-markdown-alerts-extension 1.0.4__tar.gz

jupyterlab_github_markdown_alerts_extension-1.0.4/.claude/CLAUDE.md

@@ -0,0 +1,61 @@
+<!-- Import workspace-level CLAUDE.md configuration -->
+<!-- See /home/lab/workspace/.claude/CLAUDE.md for complete rules -->
+
+# Project-Specific Configuration
+
+This file extends workspace-level configuration with project-specific rules.
+
+## Project Context
+
+**Project**: JupyterLab GitHub Markdown Alerts Extension
+
+**Purpose**: A JupyterLab 4 extension that renders GitHub-style alert blocks in Markdown cells, supporting NOTE, TIP, IMPORTANT, WARNING, and CAUTION alert types.
+
+**Technology Stack**:
+- JupyterLab 4.x
+- TypeScript 5.8
+- CSS modules for styling
+- Jest for unit testing
+- Playwright/Galata for integration testing
+- Hatchling for Python packaging
+- Yarn (jlpm) for JavaScript package management
+
+**Key Components**:
+- `/src/index.ts` - Main extension entry point
+- `/style/base.css` - Alert styling definitions
+- `/style/index.css` - Style module entry
+- `pyproject.toml` - Python package configuration
+- `package.json` - JavaScript package configuration
+
+**Alert Types Supported**:
+```markdown
+> [!NOTE]
+> [!TIP]
+> [!IMPORTANT]
+> [!WARNING]
+> [!CAUTION]
+```
+
+**Development Workflow**:
+- Use `jlpm` for JavaScript operations (JupyterLab's pinned yarn)
+- Development mode: `jupyter labextension develop . --overwrite`
+- Watch mode: `jlpm watch` + `jupyter lab` in separate terminals
+- Tests: `jlpm test` (unit), `ui-tests/` (integration)
+
+**Naming Conventions**:
+- Python package: `jupyterlab_github_markdown_alerts_extension` (underscores)
+- NPM package: `jupyterlab_github_markdown_alerts_extension` (underscores, matching Python)
+- CSS classes: kebab-case with `jp-` prefix for JupyterLab conventions
+- TypeScript: PascalCase for interfaces (must start with `I`), camelCase for functions
+
+**Build Process**:
+- Development: `jlpm build` (with source maps)
+- Production: `jlpm build:prod` (optimized)
+- Clean: `jlpm clean:all` (removes all build artifacts)
+
+**Publishing**:
+- Python: PyPI via hatchling
+- JavaScript: Bundled with Python package (labextension)
+- See RELEASE.md for release process
+
+**GitHub Repository**: TBD - needs repository URL configuration in package.json and pyproject.toml

jupyterlab_github_markdown_alerts_extension-1.0.4/.claude/JOURNAL.md

@@ -0,0 +1,29 @@
+# Claude Code Journal
+
+This journal tracks substantive work on documents, diagrams, and documentation content.
+
+---
+
+1. **Task - Implement GitHub markdown alerts extension**: Implemented complete JupyterLab 4 extension for rendering GitHub-style alert blocks (NOTE, TIP, IMPORTANT, WARNING, CAUTION) in markdown cells<br>
+    **Result**: Created TypeScript plugin with markdown parser integration (src/index.ts), comprehensive CSS styling with light/dark theme support (style/base.css), embedded SVG icons for all five alert types, and updated README.md with modus primaris documentation style. Extension successfully builds and integrates with JupyterLab's markdown renderer.
+
+2. **Task - Fix markdown parsing within alerts**: Resolved issue where markdown formatting (bold, italic, links, etc.) was not being processed inside alert content blocks<br>
+    **Result**: Implemented two-phase processing approach using HTML comment markers (src/index.ts:87-122). Alert blocks are now marked with comments before markdown rendering, allowing the markdown parser to process formatting, then post-processed to wrap content in styled divs. This preserves all markdown features within alert content.
+
+3. **Task - Match alerts.html structure exactly**: Corrected icon class names to match GitHub's actual HTML structure from alerts.html reference file<br>
+    **Result**: Updated IAlertConfig interface and ALERT_TYPES configuration to include iconClass property (src/index.ts:11-54). Icon classes now use GitHub's semantic names: octicon-info (NOTE), octicon-light-bulb (TIP), octicon-report (IMPORTANT), octicon-alert (WARNING), octicon-stop (CAUTION). Modified createIcon function to accept iconClass parameter.
+
+4. **Task - Verify GitHub styling compliance**: Investigated GitHub's official documentation and Primer design system to validate CSS color values and styling approach<br>
+    **Result**: Confirmed existing CSS implementation (style/base.css) uses accurate GitHub color scheme. Light theme colors: blue (#0969da) for NOTE, green (#1a7f37) for TIP, purple (#8250df) for IMPORTANT, orange (#9a6700) for WARNING, red (#d1242f) for CAUTION. Dark theme uses adjusted colors for better contrast. Styling matches GitHub's visual appearance with 0.25rem left border, 6px border-radius, and appropriate padding.
+
+5. **Task - Extract and match exact GitHub styling**: Analyzed alerts-full-page.html and extracted actual GitHub CSS rules from production stylesheets<br>
+    **Result**: Discovered significant styling differences. Updated style/base.css to match GitHub exactly: removed background-color (GitHub uses only left border without background tint), removed border-radius (GitHub has no rounded corners), changed border-width to .25em (not .25rem), updated padding to 0.5rem 1rem, changed font-weight to 500 (medium, not 600 semibold), set line-height to 1, removed margin-bottom from title, updated CAUTION color to #cf222e. Extension now matches GitHub's production styling precisely.
+
+6. **Task - Add optional background colors setting**: Implemented JupyterLab settings system to allow users to optionally enable colored backgrounds for alerts<br>
+    **Result**: Created schema/plugin.json with showBackgrounds boolean setting (default: false). Added @jupyterlab/settingregistry dependency to package.json. Updated src/index.ts to read settings and conditionally apply markdown-alert-with-backgrounds CSS class. Added CSS rules in style/base.css for optional backgrounds with 10% opacity (light theme) and 15% opacity (dark theme). Settings accessible via Settings → Settings Editor → GitHub Markdown Alerts. Default behavior matches GitHub exactly with no backgrounds.
+
+7. **Task - Fix icon rendering**: Resolved issue where SVG icons were not visible in rendered alerts due to JupyterLab's HTML sanitizer stripping inline SVG elements<br>
+    **Result**: Replaced inline SVG with img tags using base64-encoded data URIs (src/index.ts:60-90). Modified createIcon function to generate both light and dark theme icon versions with appropriate colors baked into each SVG. Added iconColor and iconColorDark properties to IAlertConfig. Implemented CSS theme switching in style/base.css using .octicon-light and .octicon-dark classes with body[data-jp-theme-light='false'] selector for dark theme detection. Icons now render correctly with proper colors matching GitHub's theme-specific palette.
+
+8. **Task - Finalize extension for release**: Updated documentation, removed temporary files, bumped version, and aligned GitHub workflows with production standards<br>
+    **Result**: Integrated ALERTS.md content into README.md with alert examples and settings documentation. Removed standalone ALERTS.md file. Bumped version from 0.1.6 to 1.0.1 in package.json (pyproject.toml inherits version via hatch nodejs source). Updated .github/workflows/build.yml to match reference implementation: removed lint and test steps (not yet implemented), updated Python version to 3.12 for test_isolated job. Extension ready for production release with complete GitHub-style alert rendering, theme support, and optional background colors. Added debug logging to src/index.ts for troubleshooting markdown rendering pipeline (console.log statements in markdownParser.render function).

jupyterlab_github_markdown_alerts_extension-1.0.4/.claude/settings.local.json

@@ -0,0 +1,22 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(mkdir:*)",
+      "Bash(jlpm install:*)",
+      "Bash(jlpm build:*)",
+      "WebFetch(domain:docs.github.com)",
+      "WebFetch(domain:github.com)",
+      "WebFetch(domain:primer.style)",
+      "Bash(curl:*)",
+      "Bash(cat:*)",
+      "Bash(git add:*)",
+      "Bash(git commit:*)",
+      "Bash(git push:*)",
+      "Bash(git reset:*)",
+      "Bash(git tag:*)",
+      "Bash(git rm:*)"
+    ],
+    "deny": [],
+    "ask": []
+  }
+}

jupyterlab_github_markdown_alerts_extension-1.0.4/.copier-answers.yml

@@ -0,0 +1,16 @@
+# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
+_commit: v4.5.0
+_src_path: https://github.com/jupyterlab/extension-template
+author_email: konrad.jelen@gmail.com
+author_name: Stellars Henson
+has_ai_rules: false
+has_binder: false
+has_settings: false
+kind: frontend
+labextension_name: jupyterlab_github_markdown_alerts_extension
+project_short_description: Jupyterlab extension to render alerts tips like they are
+    rendered in github in markdown
+python_name: jupyterlab_github_markdown_alerts_extension
+repository: ''
+test: true
+

jupyterlab_github_markdown_alerts_extension-1.0.4/.gitignore

@@ -0,0 +1,128 @@
+*.bundle.*
+lib/
+node_modules/
+*.log
+.eslintcache
+.stylelintcache
+*.egg-info/
+.ipynb_checkpoints
+*.tsbuildinfo
+jupyterlab_github_markdown_alerts_extension/labextension
+# Version file is handled by hatchling
+jupyterlab_github_markdown_alerts_extension/_version.py
+
+# Integration tests
+ui-tests/test-results/
+ui-tests/playwright-report/
+
+# Created by https://www.gitignore.io/api/python
+# Edit at https://www.gitignore.io/?templates=python
+
+### Python ###
+# Virtual environments
+.venv
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage/
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# End of https://www.gitignore.io/api/python
+
+# OSX files
+.DS_Store
+
+# Yarn cache
+.yarn/

jupyterlab_github_markdown_alerts_extension-1.0.4/.prettierignore

@@ -0,0 +1,6 @@
+node_modules
+**/node_modules
+**/lib
+**/package.json
+!/package.json
+jupyterlab_github_markdown_alerts_extension

jupyterlab_github_markdown_alerts_extension-1.0.4/.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

jupyterlab_github_markdown_alerts_extension-1.0.4/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+<!-- <START NEW CHANGELOG ENTRY> -->
+
+<!-- <END NEW CHANGELOG ENTRY> -->

jupyterlab_github_markdown_alerts_extension-1.0.4/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2025, Stellars Henson
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

jupyterlab_github_markdown_alerts_extension-1.0.4/Makefile

@@ -0,0 +1,118 @@
+# Makefile for Jupyterlab extensions version 1.26
+# author: Stellars Henson <konrad.jelen@gmail.com>
+# License: MIT Open Source License
+
+.PHONY: build install clean uninstall publish dependencies mrproper increment_version install_dependencies check_dependencies upgrade help
+.DEFAULT_GOAL := help
+
+# Read current version from package.json (only if node is available)
+VERSION := $(shell command -v node >/dev/null 2>&1 && node -p "require('./package.json').version" || echo "0.0.0")
+
+## increment project version
+increment_version:
+	@echo "Current version: $(VERSION)"
+	@bash -c 'CURRENT_VERSION=$(VERSION); \
+	IFS="." read -r major minor patch <<< "$$CURRENT_VERSION"; \
+	NEW_PATCH=$$((patch + 1)); \
+	NEW_VERSION="$$major.$$minor.$$NEW_PATCH"; \
+	echo "New version: $$NEW_VERSION"; \
+	sed -i "s/\"version\": \"$$CURRENT_VERSION\"/\"version\": \"$$NEW_VERSION\"/" package.json; '
+
+## build packages
+build: clean increment_version check_dependencies
+	npm install
+	yarn install
+	python -m build
+
+## install package
+install: build 
+	pip install dist/*.whl --force-reinstall
+
+## clean builds and installables
+clean: uninstall  check_dependencies
+	@command -v npm >/dev/null 2>&1 && npm run clean || true
+	@command -v npm >/dev/null 2>&1 && npm run clean:labextension || true
+	rm -rf dist lib || true
+
+## uninstall package
+uninstall:  check_dependencies
+	pip uninstall -y dist/*.whl 2>/dev/null || true
+
+## check if required dependencies are installed
+check_dependencies:
+	@echo "Checking dependencies..."
+	@MISSING=""; \
+	command -v node >/dev/null 2>&1 || MISSING="$$MISSING node"; \
+	command -v npm >/dev/null 2>&1 || MISSING="$$MISSING npm"; \
+	command -v yarn >/dev/null 2>&1 || MISSING="$$MISSING yarn"; \
+	command -v twine >/dev/null 2>&1 || MISSING="$$MISSING twine"; \
+	if [ -n "$$MISSING" ]; then \
+		echo "Missing dependencies:$$MISSING"; \
+		echo "Installing missing dependencies..."; \
+		$(MAKE) install_dependencies; \
+	else \
+		echo "All dependencies are installed."; \
+	fi
+
+## publish package to public repository
+publish: check_dependencies install
+	npm publish --access public
+	twine upload dist/*
+
+## install all required build dependencies
+install_dependencies:
+	conda install -y nodejs yarn --update-all
+	pip install twine
+	npm install rimraf
+
+## upgrade all npm and yarn dependencies
+upgrade: check_dependencies
+	jlpm up
+
+## cleanup all build and metabuild artefacts
+mrproper: clean uninstall
+	rm -rf node_modules .yarn || true
+
+## prints the list of available commands
+help:
+	@echo ""
+	@echo "$$(tput bold)Available rules:$$(tput sgr0)"
+	@sed -n -e "/^## / { \
+		h; \
+		s/.*//; \
+		:doc" \
+		-e "H; \
+		n; \
+		s/^## //; \
+		t doc" \
+		-e "s/:.*//; \
+		G; \
+		s/\\n## /---/; \
+		s/\\n/ /g; \
+		p; \
+	}" ${MAKEFILE_LIST} \
+	| LC_ALL='C' sort --ignore-case \
+	| awk -F '---' \
+		-v ncol=$$(tput cols) \
+		-v indent=19 \
+		-v col_on="$$(tput setaf 6)" \
+		-v col_off="$$(tput sgr0)" \
+	'{ \
+		printf "%s%*s%s ", col_on, -indent, $$1, col_off; \
+		n = split($$2, words, " "); \
+		line_length = ncol - indent; \
+		for (i = 1; i <= n; i++) { \
+			line_length -= length(words[i]) + 1; \
+			if (line_length <= 0) { \
+				line_length = ncol - indent - length(words[i]) - 1; \
+				printf "\n%*s ", -indent, " "; \
+			} \
+			printf "%s ", words[i]; \
+		} \
+		printf "\n"; \
+	}' 
+	@echo ""
+
+
+# EOF
+

jupyterlab_github_markdown_alerts_extension-1.0.4/PKG-INFO

@@ -0,0 +1,212 @@
+Metadata-Version: 2.4
+Name: jupyterlab_github_markdown_alerts_extension
+Version: 1.0.4
+Summary: Jupyterlab extension to render alerts tips like they are rendered in github in markdown
+Project-URL: Homepage, https://github.com/stellarshenson/jupyterlab_github_markdown_alerts_extension
+Project-URL: Bug Tracker, https://github.com/stellarshenson/jupyterlab_github_markdown_alerts_extension/issues
+Project-URL: Repository, https://github.com/stellarshenson/jupyterlab_github_markdown_alerts_extension.git
+Author-email: Stellars Henson <konrad.jelen@gmail.com>
+License: BSD 3-Clause License
+        
+        Copyright (c) 2025, Stellars Henson
+        All rights reserved.
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+        
+        1. Redistributions of source code must retain the above copyright notice, this
+           list of conditions and the following disclaimer.
+        
+        2. Redistributions in binary form must reproduce the above copyright notice,
+           this list of conditions and the following disclaimer in the documentation
+           and/or other materials provided with the distribution.
+        
+        3. Neither the name of the copyright holder nor the names of its
+           contributors may be used to endorse or promote products derived from
+           this software without specific prior written permission.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+License-File: LICENSE
+Keywords: jupyter,jupyterlab,jupyterlab-extension
+Classifier: Framework :: Jupyter
+Classifier: Framework :: Jupyter :: JupyterLab
+Classifier: Framework :: Jupyter :: JupyterLab :: 4
+Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
+Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# JupyterLab GitHub Markdown Alerts Extension
+
+[![Github Actions Status](/workflows/Build/badge.svg)](/actions/workflows/build.yml)
+
+A JupyterLab 4 extension that renders GitHub-style alert blocks in Markdown cells, providing visual emphasis for notes, tips, warnings, and other important information.
+
+This extension brings GitHub's alert syntax to JupyterLab, allowing you to create styled callout blocks using simple markdown notation. Alerts automatically adapt to light and dark themes, matching GitHub's visual design.
+
+**Key Features**:
+- Five alert types - NOTE, TIP, IMPORTANT, WARNING, CAUTION
+- Automatic theme adaptation - colors adjust for light and dark modes
+- GitHub-compatible syntax - works with standard GitHub markdown alert notation
+- Icon integration - each alert type displays with its corresponding icon
+- Zero configuration - works immediately after installation
+
+## Requirements
+
+- JupyterLab >= 4.0.0
+
+## Usage
+
+Create alert blocks in markdown cells using GitHub's alert syntax. Start with a blockquote containing the alert type, followed by content lines:
+
+```
+> [!NOTE]
+> Useful information that users should know, even when skimming content.
+
+> [!TIP]
+> Helpful advice for doing things better or more easily.
+
+> [!IMPORTANT]
+> Key information users need to know to achieve their goal.
+
+> [!WARNING]
+> Urgent info that needs immediate user attention to avoid problems.
+
+> [!CAUTION]
+> Advises about risks or negative outcomes of certain actions.
+```
+
+Each alert type renders with distinct colors and icons matching GitHub's design. Multi-line content is supported by continuing the blockquote format.
+
+**Alert Examples**:
+
+> [!NOTE]
+> Useful information that users should know, even when skimming content.
+
+> [!TIP]
+> Helpful advice for doing things better or more easily.
+
+> [!IMPORTANT]
+> Key information users need to know to achieve their goal.
+
+> [!WARNING]
+> Urgent info that needs immediate user attention to avoid problems.
+
+> [!CAUTION]
+> Advises about risks or negative outcomes of certain actions.
+
+## Settings
+
+The extension provides optional settings accessible through JupyterLab's Settings Editor:
+
+- **Show Alert Backgrounds** - Enable subtle colored backgrounds for alerts (disabled by default to match GitHub exactly)
+
+To access settings: Settings → Settings Editor → GitHub Markdown Alerts
+
+## Install
+
+```bash
+pip install jupyterlab_github_markdown_alerts_extension
+```
+
+## Uninstall
+
+```bash
+pip uninstall jupyterlab_github_markdown_alerts_extension
+```
+
+## Contributing
+
+### Development install
+
+Note: You will need NodeJS to build the extension package.
+
+The `jlpm` command is JupyterLab's pinned version of
+[yarn](https://yarnpkg.com/) 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_github_markdown_alerts_extension directory
+
+# Set up a virtual environment and install package in development mode
+python -m venv .venv
+source .venv/bin/activate
+pip install --editable "."
+
+# Link your development version of the extension with JupyterLab
+jupyter labextension develop . --overwrite
+
+# Rebuild extension Typescript source after making changes
+# IMPORTANT: Unlike the steps above which are performed only once, do this step
+# every time you make a change.
+jlpm 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 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 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_github_markdown_alerts_extension
+```
+
+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_github_markdown_alerts_extension` within that folder.
+
+### Testing the extension
+
+#### Frontend tests
+
+This extension is using [Jest](https://jestjs.io/) for JavaScript code testing.
+
+To execute them, execute:
+
+```sh
+jlpm
+jlpm test
+```
+
+#### Integration tests
+
+This extension uses [Playwright](https://playwright.dev/docs/intro) for the integration tests (aka user level tests).
+More precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab.
+
+More information are provided within the [ui-tests](./ui-tests/README.md) README.
+
+### Packaging the extension
+
+See [RELEASE](RELEASE.md)