What is notebookmd CLAUDE.md?

Project instructions for notebookmd, a Python package that creates structured Markdown reports from data-analysis calls such as tables, metrics, and charts.

Use them when working on the package, its plug-ins, report generation, or the process for creating an analysis report.

They explain how the package’s core and plug-ins fit together, so changes follow its existing design instead of duplicating built-in behavior.

How minhlucvan/notebookmd configures Claude Code

Reuse

Borrowing it

Nothing to install: this file belongs to minhlucvan/notebookmd. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file

curl -O https://raw.githubusercontent.com/minhlucvan/notebookmd/main/CLAUDE.md

Clone the repo

git clone --depth 1 https://github.com/minhlucvan/notebookmd

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/minhlucvan/notebookmd/claude-md/github.svg)](https://agentmods.dev/instructions/minhlucvan/notebookmd/claude-md)

Your own site

<a href="https://agentmods.dev/instructions/minhlucvan/notebookmd/claude-md"><img src="https://agentmods.dev/badge/instructions/minhlucvan/notebookmd/claude-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/minhlucvan/notebookmd/claude-md"><img src="https://agentmods.dev/badge/instructions/minhlucvan/notebookmd/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 1,402 This file is loaded in full into every session.

When invoked 1,402 The same file — it is already loaded in full.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5.1	$0.01402	$0.01402
Opus 5.5	$0.00561	$0.00561
Sonnet 5.5	$0.00280	$0.00280
Haiku 4.5	$0.00140	$0.00140

Measured 2mo ago against content hash 42a62c3de5f1, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

notebookmd CLAUDE.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

CLAUDE.md · 130 lines

How it starts

The opening of the file, as written. The whole thing — 130 lines — stays where its author put it; the contents beside it link to each section on GitHub.

notebookmd — Project Instructions

Overview

notebookmd is a Python package that provides a Streamlit-like API for generating structured Markdown reports. It is designed for AI agents doing data analysis — agents call n.metric(), n.table(), n.line_chart() etc. and get clean, structured Markdown output.

Architecture

The package uses a core + plugin architecture. The Notebook class is a thin core that handles markdown buffering, asset management, and report lifecycle. All widget methods (metric(), table(), line_chart(), etc.) are provided by plugins that are auto-loaded.

notebookmd/
├── __init__.py          # Public API: nb(), Notebook, NotebookConfig, PluginSpec, register_plugin
├── core.py              # Notebook class — core engine + plugin loading
├── plugins/             # Plugin system — base class, registry, and built-in plugins
│   ├── __init__.py      # Re-exports: PluginSpec, register_plugin, BUILTIN_PLUGINS, all plugin classes
│   ├── _base.py         # PluginSpec base class
│   ├── _registry.py     # Global registry, entry-point discovery, load_default_plugins
│   ├── text.py          # TextPlugin: title, header, subheader, caption, md, note, code, text, latex, divider
│   ├── data.py          # DataPlugin: table, dataframe, metric, metric_row, json, kv, summary
│   ├── charts.py        # ChartPlugin: line_chart, area_chart, bar_chart, figure, plotly_chart, altair_chart
│   ├── status.py        # StatusPlugin: success, error, warning, info, exception, progress, toast, balloons, snow
│   ├── layout.py        # LayoutPlugin: expander, container, tabs, columns
│   ├── media.py         # MediaPlugin: image, audio, video
│   ├── analytics.py     # AnalyticsPlugin: stat, stats, badge, change, ranking
│   └── utility.py       # UtilityPlugin: write, echo, empty, connection_status, export_csv
├── widgets.py           # 40+ widget renderers (metrics, charts, layout, status)
├── emitters.py          # Low-level Markdown emitters (table, figure, code, kv)
├── capture.py           # Stdout/stderr capture utilities
├── assets.py            # AssetManager — saves figures, CSVs, tracks artifacts
└── py.typed             # PEP 561 type checking marker

Read the full file on GitHub · 130 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

2mo ago First seen · 130 lines · 1,402 tokens per session scan A 42a62c3de5f1

Subscribe to this mod's changes

notebookmd CLAUDE.md is an instructions file published in the GitHub repository minhlucvan/notebookmd (10 stars, last pushed 6mo ago), licensed MIT. It adds 1,402 tokens to every session, about $0.0056 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

ai-agents generator markdown notebook reporting

notebookmd CLAUDE.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
notebookmd CLAUDE.mdminhlucvan/notebookmd	Instructions file	10	6mo ago	MIT	A	1,402	Claude Code
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	today	MIT	A	7,461	Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	yesterday	MIT	A	4,680	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	5,516	GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	3,093	GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harness	Instructions file	274k	2d ago	MIT	A	4,313	Codex, OpenCode

notebookmd: Instructions file for Claude Code