CodebaseMD is a Visual Studio Code extension that allows you to export your entire codebase or selected files as a Markdown file, making it easier to share and document your projects.
- 1-Click Export Entire Codebase as Markdown: Export your entire project into a single markdown file with the folder structure and code files included.
- Exclude Unnecessary Files Automatically: Automatically excludes files and folders like those in
.gitignore,node_modules,build,out, and large files such aspackage-lock.json. - Export Selected Files: Right-click on selected files or folders and export only those to Markdown.
- Markdown Compatible Output: Only actively coded files with supported extensions (e.g.,
.js,.ts,.py,.html, etc.) are included with their contents, while unsupported files are listed with their names and paths.
You can install CodebaseMD directly from the Visual Studio Marketplace.
- Download the
.vsixfile from the releases section. - Open VS Code.
- Go to Extensions (
Ctrl+Shift+XorCmd+Shift+Xon macOS). - Click on the three dots in the top-right corner, then choose Install from VSIX.
- Select the downloaded
.vsixfile.
- Open the Command Palette (
Ctrl+Shift+PorCmd+Shift+P). - Search for and run the command Export Codebase as Markdown.
- In the Explorer view, select multiple files or folders.
- Right-click and choose Export Selected as Markdown.
The exported markdown file will have:
- Project Statistics: Total number of files exported.
- Folder Structure: A tree-like structure of your project.
- Code Files: Each file's contents enclosed in a code block with proper syntax highlighting.
- Unsupported Files: Unsupported file types will be listed with their file paths but not their contents.
Contributions are welcome! Feel free to open issues, submit pull requests, or suggest new features.
This project is licensed under the MIT License. See the LICENSE file for details.
- Alphin Tom
- Email: alphinctom@gmail.com
- GitHub: alpha912