Welcome to md-hierarchy! This tool helps you turn large markdown files into a well-structured folder system. This makes it easier for you to navigate and edit your documents, especially when using AI tools.
To get started, you need to download the software. You can find the latest version on our Releases page.
- Click the link to visit the Releases page.
- Look for the latest version at the top and find the appropriate download file for your operating system.
- Download the file and save it to your computer.
Before you install, ensure your system meets the following requirements:
- Operating System: Windows 10, macOS Catalina or later, Linux (any modern distribution)
- RAM: Minimum 4 GB
- Storage: At least 100 MB of free space
- Additional Software: None needed; this tool runs independently.
Using md-hierarchy is straightforward. Follow these steps to start organizing your markdown files:
-
Locate your markdown files: Gather the files you want to organize. Put them in one main folder for easy access.
-
Run the Application:
- On Windows: Double-click the downloaded file (.exe) to start the application.
- On macOS: Open the .dmg file and drag md-hierarchy to your Applications folder.
- On Linux: Open a terminal and run the downloaded executable.
-
Select the Files: When the application opens, click on the βAdd Filesβ button. Choose the markdown files you want to transform.
-
Set Options: You can adjust settings like:
- Output Folder: Choose where the new files will go.
- Structure Type: Pick how you want your folders organized (by date, by topic, etc.).
-
Start the Process: Click the βTransformβ button. The tool will create folders and organize your files according to your settings.
-
Access Your Files: Once the process finishes, navigate to the output folder you selected. There, you will find your organized markdown files.
Here are some key features of md-hierarchy:
- Hierarchical Organization: Creates a clear folder structure for easy navigation.
- Customizable Settings: Adjust how your files are organized.
- User-Friendly: Designed for anyone, regardless of technical expertise.
- Works with Large Files: Capable of handling multiple files at once.
- AI Compatibility: Prepared for use with AI-assisted editing tools.
This application touches on various important topics related to document management and markdown:
- Command Line Interface (CLI)
- File Organization
- Markdown Parsing
- Document Management
- Static Site Generation
If you encounter any issues while using md-hierarchy, please refer to the Issues page on GitHub. You can report bugs or ask questions there.
For suggestions or feedback, feel free to contact us through the GitHub repository.
For more detailed information, check out the documentation available in the repository. Explore further on how to maximize your use of markdown files and best practices for organized writing.
md-hierarchy is released under the MIT License. You are free to use, modify, and distribute it as you wish.