Skip to content

Commit 8267da6

Browse files
committed
docs: add project README with usage instructions and features
1 parent dcd4c6e commit 8267da6

File tree

2 files changed

+64
-0
lines changed

2 files changed

+64
-0
lines changed

README.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# CodebaseMD
2+
3+
[![VSCode Extension Version](https://img.shields.io/visual-studio-marketplace/v/alpha912.codebase-md)](https://marketplace.visualstudio.com/items?itemName=alpha912.codebase-md)
4+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5+
6+
**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.
7+
8+
## Features
9+
10+
- **1-Click Export Entire Codebase as Markdown**: Export your entire project into a single markdown file with the folder structure and code files included.
11+
- **Exclude Unnecessary Files Automatically**: Automatically excludes files and folders like those in `.gitignore`, `node_modules`, `build`, `out`, and large files such as `package-lock.json`.
12+
- **Export Selected Files**: Right-click on selected files or folders and export only those to Markdown.
13+
- **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.
14+
15+
## Installation
16+
17+
### From Visual Studio Marketplace
18+
19+
You can install **CodebaseMD** directly from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=alpha912.codebase-md).
20+
21+
### Manually via VSIX
22+
23+
1. Download the `.vsix` file from the [releases section](https://github.com/alpha912/codebase-md/releases).
24+
2. Open **VS Code**.
25+
3. Go to **Extensions** (`Ctrl+Shift+X` or `Cmd+Shift+X` on macOS).
26+
4. Click on the **three dots** in the top-right corner, then choose **Install from VSIX**.
27+
5. Select the downloaded `.vsix` file.
28+
29+
## Usage
30+
31+
### 1. Export the Entire Codebase
32+
33+
- Open the **Command Palette** (`Ctrl+Shift+P` or `Cmd+Shift+P`).
34+
- Search for and run the command **Export Codebase as Markdown**.
35+
36+
### 2. Export Selected Files/Folders
37+
38+
- In the **Explorer** view, select multiple files or folders.
39+
- Right-click and choose **Export Selected as Markdown**.
40+
41+
### Example of Exported Markdown
42+
43+
The exported markdown file will have:
44+
45+
- **Project Statistics**: Total number of files exported.
46+
- **Folder Structure**: A tree-like structure of your project.
47+
- **Code Files**: Each file's contents enclosed in a code block with proper syntax highlighting.
48+
- **Unsupported Files**: Unsupported file types will be listed with their file paths but not their contents.
49+
50+
## Contributing
51+
52+
Contributions are welcome! Feel free to open issues, submit pull requests, or suggest new features.
53+
54+
## License
55+
56+
This project is licensed under the MIT License. See the [LICENSE](https://github.com/alpha912/codebase-md/blob/master/LICENSE.md) file for details.
57+
58+
---
59+
60+
### **Author**
61+
62+
- **Alphin Tom**
63+
- **Email**: [[email protected]](mailto:[email protected])
64+
- **GitHub**: [alpha912](https://github.com/alpha912)

0 commit comments

Comments
 (0)