{"repo":"mistermicheels/markdown-notes-tree","free":true,"listed":false,"github":"https://github.com/mistermicheels/markdown-notes-tree","clone":"git clone https://github.com/mistermicheels/markdown-notes-tree.git","description":"Generate Markdown trees that act as a table of contents for a folder structure with Markdown notes","language":"JavaScript","stars":41,"topics":["markdown","notes","tree","docs","documentation","toc","table","contents","table-of-contents","toc-generator"],"license":"MIT","category":"productivity","readme_excerpt":"Project status: - ✅ Actively maintained - 🐢 Limited bandwidth - 🔒 Not looking for code contributions from other developers markdown-notes-tree If you have a folder structure with Markdown notes, you can use this tool to generate Markdown trees that act as a table of contents for the folder structure. Example input and expected result Real-life example By default, the tool does the following: - Append a complete tree to the main README.md file (in the directory where the tool is executed) - Write/overwrite README.md files in subdirectories, each containing the subdirectory's name as title and a tree of the subdirectory's contents (can be disabled through command line arguments) You can run the tool again and again without changing the result. Once a tree has been written to your main README.md file, you can add anything below the tree (or move the tree) and the tool will respect the tree's boundaries. Of course, it is recommended to run the tool again every time you make changes to the Markdown notes in your folder structure. It can be useful to include the tool in build scripts or pre-commit hooks. Install Not using Node for your project? You can install markdown-notes-tree globally, or you can even add it as a pre-commit plugin. Example pre-commit configuration: Use You can run the tool by running npx markdown-notes-tree from the command line or invoking markdown-notes-tree from an npm script. Make sure to run the tool in the top-level directory of your Markdown notes fold","default_branch":null,"files":null,"tree":[],"storefront":"/r/mistermicheels","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/mistermicheels/markdown-notes-tree/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}