Notes Folder Index

A table of contents for a notes directory.

Overview

This repository is Notes Folder Index, a developer utility. A table of contents for a notes directory.

A notes folder has no map.

Run it in a clone, check the output, then keep or discard the file it wrote.

How to get it

This GitHub repository is the Python CLI source (MIT). Clone it, install requirements, run main.py.

A desktop build for Windows and macOS (installer, no Python required) is on the setup page. Same workflow, packaged for everyday use.

Features

• Title from heading
• First line summary
• Relative links
• UTF-8

Environment

• Windows 10 or 11 for the desktop build
• Python 3.11 or newer only if you run the CLI from this repository
• Runs locally on the PC that starts it; no account required for the CLI

CLI

Python 3.11 or newer. From the repository root:

pip install -r requirements.txt
python main.py --help

--preview prints the plan and does not write. --out sets an output folder when the command supports it.

Download

Windows and macOS installer

Source: https://github.com/n-herrera3650/notes-folder-index

MIT license. See LICENSE.