jupyterlab-markdown-insert-content-extension 1.0.21__tar.gz

jupyterlab_markdown_insert_content_extension-1.0.21/.claude/CLAUDE.md

@@ -0,0 +1,36 @@
+<!-- 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 Markdown Insert Content Extension
+**Type**: JupyterLab extension (TypeScript/Python hybrid)
+**Purpose**: Extension for inserting reusable content blocks into markdown cells in JupyterLab
+
+### Technology Stack
+
+- JupyterLab 4.x extension framework
+- TypeScript for frontend components
+- Python for backend server extension
+- npm/yarn for JavaScript dependency management
+- jlpm for JupyterLab-specific tooling
+- pytest for Python testing
+
+### Naming Conventions
+
+- Package name: `jupyterlab_markdown_insert_content_extension`
+- Repository naming follows pattern: `jupyterlab_<feature>_extension`
+- Python module uses underscores
+- TypeScript/JavaScript uses camelCase for variables, PascalCase for classes
+
+### Development Workflow
+
+- Use `jlpm` command for package management (JupyterLab's wrapper around yarn)
+- Development install: `pip install -e .`
+- Build frontend: `jlpm build`
+- Watch mode: `jlpm watch`
+- Standard JupyterLab extension structure with `src/` and `style/` directories

jupyterlab_markdown_insert_content_extension-1.0.21/.claude/JOURNAL.md

@@ -0,0 +1,35 @@
+# Claude Code Journal
+
+This journal tracks substantive work on documents, diagrams, and documentation content.
+
+---
+
+1. **Task - Project initialization and configuration**: Set up project-level Claude configuration by creating `.claude/CLAUDE.md` with project context for JupyterLab extension development and `.claude/JOURNAL.md` for tracking substantive work<br>
+   **Result**: Established local configuration importing workspace-level rules with technology stack details (JupyterLab 4.x, TypeScript, Python), naming conventions, and development workflow guidelines
+
+2. **Task - TOC generation research**: Analyzed jupyterlab_markdown_viewer_toc_fix repository to understand JupyterLab's TOC mechanisms, markdown anchor generation, and navigation patterns<br>
+   **Result**: Documented findings on JupyterLab's TOC system including heading extraction, anchor ID generation rules (initially assumed GitHub-style lowercase), sanitizer behavior with data-jupyter-id attributes, and TableOfContentsUtils API usage
+
+3. **Task - Core TOC insertion implementation**: Implemented table of contents insertion feature with heading extraction, anchor ID generation, and cursor-aware insertion for both markdown file editors and notebook cells<br>
+   **Result**: Created complete TOC insertion functionality in src/index.ts with context menu integration, dual-mode operation (file editor and notebook), hierarchical indentation (2 spaces per level), and proper markdown link formatting
+
+4. **Task - Settings system implementation**: Added configurable settings for TOC generation including caption text and maximum heading level with JupyterLab settings registry integration<br>
+   **Result**: Created schema/plugin.json with validation rules, implemented ISettingRegistry integration with live updates, and established defaults (tocCaption: "## Table of Contents", tocMaxLevel: 6) with settings accessible via JupyterLab Settings Editor
+
+5. **Task - Code block filtering enhancement**: Enhanced heading extraction to exclude headings within fenced code blocks (``` and ~~~) to prevent false positives in generated TOC<br>
+   **Result**: Implemented state tracking in extractHeadings function to toggle inCodeBlock flag and skip lines within code fence boundaries, preventing code examples from appearing in table of contents
+
+6. **Task - Anchor ID generation correction**: Fixed anchor ID generation to match JupyterLab's actual format which preserves Title-Case and special characters rather than GitHub-style lowercase<br>
+   **Result**: Updated generateHeadingId function to preserve case and special characters (colons, commas, parentheses), replace only spaces with hyphens, and remove trailing pilcrow symbols (¶), ensuring generated links match JupyterLab's data-jupyter-id attributes exactly (e.g., "Technology Decision Summary¶" -> "Technology-Decision-Summary")
+
+7. **Task - Version and release preparation**: Incremented version from 0.1.0 to 1.0.18 marking production readiness with all core features implemented and tested<br>
+   **Result**: Updated package.json version to 1.0.18 with complete feature set including TOC insertion, settings integration, code block filtering, and JupyterLab-compatible anchor generation ready for deployment
+
+8. **Task - Settings default adjustment**: Changed default maximum heading level from 6 to 3 for more focused table of contents generation<br>
+   **Result**: Updated schema/plugin.json and src/index.ts to set tocMaxLevel default to 3, limiting TOC to H1-H3 headings by default while maintaining user configurability (1-6 range)
+
+9. **Task - README documentation update**: Rewrote README.md following modus primaris principles with features listed first, all standard badges, and integrated screenshots<br>
+   **Result**: Created flowing narrative documentation with GitHub Actions, npm, PyPI, and download badges, prominent features section with bullet points, concise usage instructions, and three screenshots (.resources/screenshot-menu.png, screenshot-toc.png, screenshot-settings.png) showing context menu, generated TOC output, and settings interface with brief explanatory text before each image
+
+10. **Task - GitHub Actions workflow update**: Replaced default workflow files with production-ready configurations from jupyterlab_markdown_viewer_toc_fix reference implementation<br>
+    **Result**: Created six workflow files - build.yml (CI with lint, test, build, package, isolated test, and integration tests), check-release.yml (release validation), enforce-label.yml (PR label enforcement), prep-release.yml (manual release preparation), publish-release.yml (two-step release publishing with npm/PyPI), and update-integration-tests.yml (Playwright snapshot updates via PR comments) with proper package naming jupyterlab_markdown_insert_content_extension throughout

jupyterlab_markdown_insert_content_extension-1.0.21/.claude/settings.local.json

@@ -0,0 +1,16 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(jlpm build:*)",
+      "Bash(jlpm install:*)",
+      "Bash(git remote:*)",
+      "Bash(git add:*)",
+      "Bash(git commit:*)",
+      "Bash(git push:*)",
+      "Bash(jlpm run lint:fix:*)",
+      "Bash(jlpm prettier:*)"
+    ],
+    "deny": [],
+    "ask": []
+  }
+}

jupyterlab_markdown_insert_content_extension-1.0.21/.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_markdown_insert_content_extension
+project_short_description: Jupyterlab extension to automatically insert content into
+    markdown - such as TOC, bibliography, list of figures etc.
+python_name: jupyterlab_markdown_insert_content_extension
+repository: ''
+test: true
+

jupyterlab_markdown_insert_content_extension-1.0.21/.git

@@ -0,0 +1 @@
+gitdir: ../../../.git/modules/private/jupyterlab/jupyterlab_markdown_insert_content_extension

jupyterlab_markdown_insert_content_extension-1.0.21/.gitignore

@@ -0,0 +1,128 @@
+*.bundle.*
+lib/
+node_modules/
+*.log
+.eslintcache
+.stylelintcache
+*.egg-info/
+.ipynb_checkpoints
+*.tsbuildinfo
+jupyterlab_markdown_insert_content_extension/labextension
+# Version file is handled by hatchling
+jupyterlab_markdown_insert_content_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_markdown_insert_content_extension-1.0.21/.prettierignore

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

jupyterlab_markdown_insert_content_extension-1.0.21/.yarnrc.yml

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

jupyterlab_markdown_insert_content_extension-1.0.21/CHANGELOG.md

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

jupyterlab_markdown_insert_content_extension-1.0.21/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_markdown_insert_content_extension-1.0.21/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_markdown_insert_content_extension-1.0.21/PKG-INFO

@@ -0,0 +1,177 @@
+Metadata-Version: 2.4
+Name: jupyterlab_markdown_insert_content_extension
+Version: 1.0.21
+Summary: Jupyterlab extension to automatically insert content into markdown - such as TOC, bibliography, list of figures etc.
+Project-URL: Homepage, https://github.com/stellarshenson/jupyterlab_markdown_insert_content_extension
+Project-URL: Bug Tracker, https://github.com/stellarshenson/jupyterlab_markdown_insert_content_extension/issues
+Project-URL: Repository, https://github.com/stellarshenson/jupyterlab_markdown_insert_content_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_markdown_insert_content_extension
+
+[![GitHub Actions](https://github.com/stellarshenson/jupyterlab_markdown_insert_content_extension/actions/workflows/build.yml/badge.svg)](https://github.com/stellarshenson/jupyterlab_markdown_insert_content_extension/actions/workflows/build.yml)
+[![npm version](https://img.shields.io/npm/v/jupyterlab_markdown_insert_content_extension.svg)](https://www.npmjs.com/package/jupyterlab_markdown_insert_content_extension)
+[![PyPI version](https://img.shields.io/pypi/v/jupyterlab_markdown_insert_content_extension.svg)](https://pypi.org/project/jupyterlab_markdown_insert_content_extension/)
+[![Total PyPI downloads](https://static.pepy.tech/badge/jupyterlab_markdown_insert_content_extension)](https://pepy.tech/project/jupyterlab_markdown_insert_content_extension)
+[![JupyterLab 4](https://img.shields.io/badge/JupyterLab-4-orange.svg)](https://jupyterlab.readthedocs.io/en/stable/)
+
+JupyterLab extension for inserting reusable content blocks into markdown files and notebook cells, starting with automatic table of contents generation.
+
+## Features
+
+- **Context menu integration** - right-click in markdown editors or notebook cells to insert content
+- **Table of contents generation** - automatically extracts headings and creates hierarchical TOC with working anchor links
+- **Configurable settings** - customize TOC caption and maximum heading depth through JupyterLab settings
+- **Code block filtering** - excludes headings within fenced code blocks from TOC
+- **JupyterLab-compatible anchors** - generates anchor IDs matching JupyterLab's format for reliable navigation
+- **Dual mode support** - works in both markdown file editors and notebook markdown cells
+- **Cursor-aware insertion** - inserts content at current cursor position
+
+Right-click in markdown editor or notebook cell to access the context menu:
+
+![](.resources/screenshot-menu.png)
+
+Generated table of contents with hierarchical structure and working anchor links:
+
+![](.resources/screenshot-toc.png)
+
+Configure TOC caption and maximum heading level through JupyterLab settings:
+
+![](.resources/screenshot-settings.png)
+
+## Requirements
+
+- JupyterLab >= 4.0.0
+
+## Install
+
+```bash
+pip install jupyterlab_markdown_insert_content_extension
+```
+
+## Usage
+
+### Insert Table of Contents
+
+1. Open a markdown file or create a markdown cell in a notebook
+2. Position cursor where you want the TOC inserted
+3. Right-click and select "Insert Table of Contents"
+4. TOC is generated with links to all headings in the document
+
+### Configure Settings
+
+Access settings through Settings -> Settings Editor -> Markdown Insert Content:
+
+- **TOC Caption** - markdown content inserted before TOC list (default: `## Table of Contents`)
+- **Maximum Heading Level** - deepest heading level to include (1-6, default: 3)
+
+Settings apply immediately without restart.
+
+## Uninstall
+
+```bash
+pip uninstall jupyterlab_markdown_insert_content_extension
+```
+
+## Development
+
+### Development install
+
+```bash
+# Clone repository
+git clone https://github.com/stellarshenson/jupyterlab_markdown_insert_content_extension.git
+cd jupyterlab_markdown_insert_content_extension
+
+# Set up virtual environment
+python -m venv .venv
+source .venv/bin/activate
+pip install --editable "."
+
+# Link extension with JupyterLab
+jupyter labextension develop . --overwrite
+
+# Build extension
+jlpm install
+jlpm build
+```
+
+### Development workflow
+
+```bash
+# Watch mode - automatically rebuilds on changes
+jlpm watch
+
+# In another terminal, run JupyterLab
+jupyter lab
+```
+
+Refresh JupyterLab after changes to load updated extension.
+
+### Development uninstall
+
+```bash
+pip uninstall jupyterlab_markdown_insert_content_extension
+jupyter labextension list  # Find labextensions folder
+# Remove symlink from labextensions folder
+```
+
+### Testing
+
+**Frontend tests**:
+
+```bash
+jlpm test
+```
+
+**Integration tests**:
+See [ui-tests/README.md](./ui-tests/README.md) for Playwright integration tests.
+
+### Packaging
+
+See [RELEASE.md](RELEASE.md) for release process.