Skip to content

MahmudZar/CodeMD

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CodeMd

CodeMd Logo

📝 About

CodeMd is a powerful web-based tool for managing and documenting code projects. It allows you to easily generate comprehensive Markdown documentation from your project structure, making it simple to share, document, and understand codebases.

✨ Features

  • Drag & Drop Interface: Simply drag your project folder or use the file picker
  • Smart File Filtering: Automatically excludes common non-essential directories (node_modules, .git, etc.)
  • Interactive Tree View: Browse your project structure with an intuitive interface
  • Markdown Generation: Creates well-formatted Markdown documentation of your project
  • Syntax Highlighting: Preview your generated documentation with proper code highlighting
  • Dark/Light Theme: Choose your preferred visual theme
  • Export Options: Copy to clipboard or download as .md file
  • File Statistics: View file count and total size information
  • Responsive Design: Works on desktop and mobile devices

🚀 Usage

  1. Select a Project: Drag & drop a folder or click "Select Project Folder"
  2. Browse Files: Use the tree view to explore your project structure
  3. Preview Documentation: Check the generated Markdown with syntax highlighting
  4. Export: Copy to clipboard or download as a Markdown file

💻 Technical Details

CodeMd runs entirely in the browser with no server-side processing, ensuring your code remains private and secure. It uses modern web technologies including:

  • Vanilla JavaScript for core functionality
  • JSTree for the interactive file tree
  • Prism.js for syntax highlighting
  • Responsive CSS for cross-device compatibility

🔧 Browser Compatibility

CodeMd works best in modern browsers that support the File System Access API:

  • Chrome/Edge (full support)
  • Firefox (most features)
  • Safari (basic support)

📄 License

MIT License

🤝 Contributing

Contributions are welcome! Feel free to open issues or submit pull requests to help improve CodeMd.

About

A web tool that instantly transforms your project folders into well-structured Markdown documentation for LLMs with just a drag and drop.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors