Skip to content

aaaduo/MarkdownHeaderList

Markdown Header List for Notepad++

Markdown Header List is an open source Notepad++ plugin that shows the heading structure of the current Markdown document in a dockable side panel.

It is designed for fast Markdown navigation with a tree view, level presets, and single-click jump-to-heading behavior.

For Chinese documentation, see README.zh-CN.md.

Screenshot

Markdown Header List screenshot

Features

  • Parses ATX-style Markdown headings from # to ######
  • Displays headings in a dockable tree panel
  • Supports expand and collapse by hierarchy
  • Supports single-click navigation to the selected heading
  • Provides H1 to H5 preset buttons for initial expansion depth
  • Supports light and dark background adaptation
  • Adds a toolbar button for quick access

Project Layout

MarkdownHeaderList/
|-- README.md
|-- README.zh-CN.md
|-- LICENSE
|-- CHANGELOG.md
|-- CONTRIBUTING.md
|-- .gitignore
|-- assets/
|   `-- demo.png
`-- src/
    |-- Makefile
    |-- MarkdownHeaderPanel.cpp
    |-- MarkdownHeaderPanel.h
    |-- PluginDefinition.cpp
    |-- PluginDefinition.h
    |-- PluginInterface.h
    |-- Notepad_plus_msgs.h
    `-- Scintilla.h

Build

This project is currently built with MinGW-w64 / MSYS2. See docs/BUILDING.md for the exact build and verification steps.

Example:

cd src
make

The built output is:

MarkdownHeaderList.dll

Install

  1. Close Notepad++.
  2. Build MarkdownHeaderList.dll.
  3. Copy the DLL into:
C:\Program Files\Notepad++\plugins\MarkdownHeaderList\
  1. Start Notepad++ again.

Usage

Open the panel from:

Plugins -> Markdown Header List -> Markdown Header List

Or click the toolbar button.

Inside the panel:

  • Click a heading to jump to it
  • Click the triangle button to expand or collapse child headings
  • Click H1 to H5 to set the initial expansion depth

Notes

  • This repository currently keeps the plugin source under src/
  • Generated .dll files should not be committed to Git
  • The project is intended for Windows and Notepad++

Documentation

License

This project is licensed under the MIT License.

See LICENSE for details.

About

A dockable Markdown heading navigator plugin for Notepad++.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors