markdown-map
Build a heading outline with source line numbers.
newpanecommand
Build a heading outline with source line numbers.
Build a heading outline with source line numbers.
Use it when: Navigate a long README or design document.
Screenshot of this mod's render tree in the fixture preview, with sample data. This is not a capture of the Claude Code application. How previews are made.
claude plugin marketplace add whyashthakker/awesome-claude-code-mods
claude plugin install markdown-map@awesome-claude-code-modsRun /reload-plugins in an existing session, then /markdown-map. Use Tab and Enter to operate controls; Esc closes the pane. Terminal and Desktop Code tab supported; pane UI is unavailable in claude -p and the VS Code chat panel.
Try the source without installing:
claude --plugin-dir ./mods/markdown-mapExample: open /markdown-map and enter README.md in its input.
Reads the chosen file (up to 256 KiB) on request. No writes, processes, network, or persistence.
Module variables reset on hot reload. All display output is bounded; viewers may truncate long content to 9,000 characters. Relative file paths and Git commands use the session working directory.
Tested with Claude Code 2.1.288. Minimum documented mods version: 2.1.287. The API can change; validate against your installed version.
claude plugin validate mods/markdown-map --strict
claude plugin test mods/markdown-mapTests cover plugin commands, pane isolation, both UI surfaces, and the behavior described in tests/register.test.ts. Drawing tests validate element trees; they do not verify pixels painted by the native apps. Validation details.
MIT licensed. No runtime packages or build step required.
hooks/register.js 61 lines1import { clean, text, code, row, frame, bar, pretty, bounded, entries, safePath } from './ui.js'
2const ID = "markdown-map"
3let target="README.md"
4let report='Open a file to inspect it.'
5
6
7function transform(source) {
8 let fence=null
9 return source.split('\n').flatMap((line,i)=>{
10 const f=line.match(/^\s{0,3}(`{3,}|~{3,})/)
11 if(f) { if(!fence) fence=f[1][0];else if(fence===f[1][0])fence=null;return [] }
12 if(fence)return []
13 const m=line.match(/^(#{1,6})\s+(.+)/)
14 return m ? [(i+1).toString().padStart(4)+' '+' '.repeat(m[1].length-1)+m[2].replace(/\s+#+\s*$/,'')] : []
15 }).join('\n') || 'No ATX headings outside fenced code.'
16}
17
18
19async function load($) {
20 try {
21 const path = safePath(target)
22 const info = await $.fs.stat(path)
23 if(info.size > 262144) throw new Error('File exceeds the 256 KiB viewer limit.')
24 const source = await $.fs.read(path)
25 report = transform(source)
26 } catch(error) { report='Could not inspect file: '+error.message }
27 $.ui.invalidate('ui.render')
28}
29
30export function register(on) {
31 on('session.start', async ($, e, next) => {
32
33 await $.command.register({name:ID, description:"Build a heading outline with source line numbers.", immediate:true, argumentHint:"[path]"})
34 return next(e)
35 })
36 on('command.run', {command:"markdown-map"}, async ($, e) => {
37 if(e.args.trim()) target=e.args.trim()
38await load($)
39 await $.ui.open({id:ID,title:"Markdown Map",focus:true,closeOnEscape:true})
40 return {}
41 })
42
43 on('ui.render', {component:'Pane'}, async ($, e, next) => {
44 if(e.requestId !== ID) return next(e)
45 const E = $.ui.resolve(e)
46 try {
47 const body = await draw($, E)
48 return frame(E,"Markdown Map","Build a heading outline with source line numbers.",body)
49 } catch(error) {
50 return frame(E,"Markdown Map",'Unable to inspect this data.',[text(E,error.message,{color:'yellow'}),E.Button({key:'refresh',label:'Refresh',onPress:()=>$.ui.invalidate('ui.render')})])
51 }
52 })
53}
54async function draw($, E) {
55 const refresh = E.Button({key:'refresh',label:'Refresh',hotkey:'r',plain:true,onPress:()=>$.ui.invalidate('ui.render')})
56
57return [E.Input({key:'target',label:'File',value:target,submitLabel:'open',onSubmit:async(value)=>{target=value;await load($)}}),
58 code(E,report,"text"),E.Button({key:'refresh',label:'Read file again',onPress:()=>load($)})]
59
60}
61hooks/ui.js 36 lines1// Pure UI helpers. No engine access; each plugin contains its own copy.
2export function clean(value, limit = 9000) {
3 return String(value ?? '').replace(/[\u0000-\u0008\u000b\u000c\u000e-\u001f\u007f-\u009f]/g, '').slice(0, limit)
4}
5export function text(E, value, props = {}) {
6 return E.Text({ ...props, children: [clean(value)] })
7}
8export function code(E, value, language = 'text') {
9 return E.Code({ source: clean(value), language })
10}
11export function row(E, children) {
12 return E.Box({ flexDirection: 'row', columnGap: 2, flexWrap: 'wrap', children })
13}
14export function frame(E, title, subtitle, children) {
15 return E.Box({ flexDirection: 'column', gap: 1, children: [
16 text(E, title, { bold: true, color: 'cyan' }),
17 text(E, subtitle, { dimColor: true }), ...children,
18 ] })
19}
20export function bar(percent, width = 24) {
21 const p = Math.max(0, Math.min(100, Number(percent) || 0))
22 const n = Math.round(p / 100 * width)
23 return '[' + '#'.repeat(n) + '-'.repeat(width - n) + '] ' + p.toFixed(1) + '%'
24}
25export function pretty(value) { return JSON.stringify(value, null, 2) }
26export function bounded(value, max = 9000) {
27 if (value.length > max) throw new Error('Input exceeds ' + max + ' characters. Use a smaller selection.')
28 return value
29}
30export function entries(value) { return value && typeof value === 'object' ? Object.entries(value) : [] }
31export function safePath(value) {
32 const path = value.trim()
33 if (!path || path.startsWith('-') || /[\x00-\x1f]/.test(path)) throw new Error('Enter a path without control characters or leading flags.')
34 return path
35}
36