Project Documentation Organizer

🚀 Getting Started

1. Click the "Load Project" button to select a folder on your computer where you want to store your documentation.
2. Once loaded, you'll see your project folder structure on the left side.

📁 Creating Files and Folders

1. Use the "New Folder" button to create folders for organizing your documentation
2. Click "New File" to create a new document
3. Choose a file type from the dropdown:
   • Markdown (.md) - Best for documentation with code examples
   • HTML (.html) - For web pages
   • Text (.txt) - Simple text files
   • Rich Text (.rtf) - Formatted text documents

📝 Writing Documentation

1. Adding Code Examples:
   • Click the "Insert Code Block" button in the toolbar
   • Select the programming language
   • Type or paste your code between the markers
2. Using Templates:
   • Select a template from the dropdown for common setups:
     • Django Project Setup
     • Conda Environment Setup
     • Code Snippet
     • Task Guide

💾 Saving Your Work

• Click the "Save" button or use Ctrl + S (or ⌘ + S on Mac) to save your changes
• Your files are saved directly to your computer in the folder you selected

👀 Previewing Your Work

• Click "Toggle Preview" to see how your documentation will look
• This is especially useful for Markdown files to see the formatted text and code blocks

📋 Best Practices

• Create separate folders for different projects or topics
• Use meaningful file names that describe the content
• For code snippets, always include:
  • A description of what the code does
  • Any prerequisites or dependencies
  • Example usage

⌨️ Keyboard Shortcuts

• Ctrl + S or ⌘ + S - Save current file
• Tab - Indent text
• Shift + Tab - Unindent text

🌳 Using the Index (Tree View)

1. Click the "Index" button in the header to open the interactive project index in a new tab.
2. Use the tree view to browse, search, and organize your documentation and code snippets.
3. To add a folder or file:
   • Right-click or use the "Add Folder"/"Add File" buttons to add new items.
   • When adding a file, you will be prompted for a display name and file path or URL.
4. Drag and drop files from your computer onto the tree to quickly add them. You will be prompted for a display name.
5. Click any file in the tree to open it (if the file is accessible via hyperlink or URL).
6. Use the "Save Index" button to download the current tree structure as a JSON file for backup or sharing.
7. Use the "Load Index" button to restore a previously saved tree structure.
8. Click "Back to Project Manager" in the index page to return here.