marktree

A CLI tool that displays the headings of a Markdown (.md) file as a tree structure.

Features

• Display Markdown heading hierarchy as a tree
• Limit the maximum heading level
• Output headings as plain text
• Read Markdown directly from the clipboard
• Copy the generated result to the clipboard
• Support UTF-8, CP932, Shift_JIS and other encodings

Japanese README

https://github.com/yusu79/marktree/blob/main/README.md

Table of Contents

• Installation
• Quick Start
• Options
• Examples
• Option Details
• Option Order
• Windows Installation Warnings
• Dependencies
• Development Diary

Installation

pip install marktree

Quick Start

Markdown file:

# h1

## h2

### h3

## h2

# h1

Run:

marktree sample.md

Output:

├── h1
│  ├── h2
│  │  └── h3
│  └── h2
└── h1

Options

Examples

Default Output

marktree sample.md

├── h1
│  ├── h2
│  │  └── h3
│  └── h2
└── h1

Limit the Heading Level

marktree -L 2 sample.md

├── h1
│  ├── h2
│  └── h2
└── h1

Read from the Clipboard

Reads the Markdown text currently stored in the clipboard.

marktree -C

You can combine it with the -L option.

marktree -C -L 3

Output Headings Only

marktree -P sample.md

Output:

# h1
## h2
### h3
## h2
# h1

Copy the Result to the Clipboard

Copies the generated tree to the clipboard instead of printing it to standard output.

marktree sample.md --copy

Specify the File Encoding

marktree -E cp932 sample.md

Supported examples:

• utf-8
• cp932
• shift_jis

Option Details

-L

Displays headings up to the specified level. Valid values are 1–6 (default: 6).

-C

Uses the Markdown text currently stored in the clipboard as input.

This allows you to view the heading structure without saving the text to a file.

-P

Outputs only the headings without tree formatting.

-E

Specifies the file encoding, for example:

marktree -E cp932 sample.md

--copy

Copies the generated output to the clipboard instead of printing it to standard output.

Option Order

Options can be specified in any order.

marktree -L 3 sample.md

marktree sample.md -L 3

If multiple Markdown files are specified, only the last one is processed.

Windows Installation Warnings

If you see:

WARNING: The script xxx.exe is installed in '...' which is not on PATH.

See:

https://yusu79.com/python-path-issue/

If you see:

WARNING: Failed to write executable - trying to use .deleteme logic

See:

https://yusu79.com/pip-install-failure-fix/

Dependencies

• pyperclip

Development Diary

https://yusu79.com/dev-marktree/