You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/usage.md
+60-1Lines changed: 60 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,11 @@
1
1
# Usage
2
2
3
-
CodebaseMD provides two main commands to export your codebase to a Markdown file:
3
+
CodebaseMD provides four main commands:
4
4
5
5
1.**Export All**: Export the entire codebase to a Markdown file
6
6
2.**Export Selected**: Export only the selected files or folders to a Markdown file
7
+
3.**Export Micro Codebase**: Export a condensed version of the entire codebase
8
+
4.**Export Selected as Micro Codebase**: Export a condensed version of selected files or folders
7
9
8
10
## Exporting the Entire Codebase
9
11
@@ -22,6 +24,63 @@ CodebaseMD provides two main commands to export your codebase to a Markdown file
22
24
5. The extension will process only the selected files, still respecting ignore patterns
23
25
6. Once complete, you will see a notification that the file was saved successfully
24
26
27
+
## Exporting Micro Codebase
28
+
29
+
The Micro Codebase export feature creates highly condensed representations of your code files, reducing size by approximately 95% while preserving essential structural information.
30
+
31
+
1. Open the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P` on macOS)
32
+
2. Type "CodebaseMD: Export Micro Codebase" and select it
33
+
3. Choose a location to save the exported Markdown file
34
+
4. The extension will analyze and condense all files in your workspace
35
+
5. Once complete, you will see a notification that the file was saved successfully
36
+
37
+
## Exporting Selected Files as Micro Codebase
38
+
39
+
1. Select one or more files or folders in the Explorer view
40
+
2. Right-click and select "CodebaseMD: Export Selected as Micro Codebase" from the context menu
41
+
3. Choose a location to save the exported Markdown file
42
+
4. The extension will analyze and condense only the selected files
43
+
5. Once complete, you will see a notification that the file was saved successfully
44
+
45
+
## Understanding the Micro Codebase Format
46
+
47
+
The Micro Codebase export uses a specialized notation to represent code structures in a condensed format:
48
+
49
+
- File metadata is shown at the top (path, description, dependencies)
50
+
- Export information summarizes what the file exposes (classes, interfaces, functions)
51
+
- Components (classes, functions, etc.) use type and visibility indicators:
52
+
- Type: C = Class, I = Interface, F = Function, V = Variable
We're excited to announce the release of CodebaseMD v2.0.0, featuring a major new capability: Micro Codebase Export!
4
+
5
+
## New Features
6
+
7
+
### Micro Codebase Export
8
+
9
+
This release introduces a powerful new feature that enables you to create highly condensed, yet informative representations of your code files. The Micro Codebase export reduces code size by approximately 95% while preserving essential structural and functional information.
10
+
11
+
#### Key Benefits
12
+
13
+
-**Size Reduction**: Condenses large files (2000+ lines) down to approximately 100 lines
14
+
-**Structural Preservation**: Maintains class hierarchies, function relationships, and module dependencies
15
+
-**Information Density**: Uses a specialized notation system to maximize information content
16
+
-**Pattern Recognition**: Automatically identifies and highlights common design patterns in your code
17
+
18
+
#### How It Works
19
+
20
+
The Micro Codebase export applies a sophisticated code condensation algorithm that:
21
+
22
+
1. Analyzes your code's structure, including classes, functions, dependencies, and patterns
23
+
2. Prioritizes information based on visibility, usage, and importance
24
+
3. Creates a condensed representation using specialized notation
25
+
4. Generates a markdown file with the micro representation of your codebase
26
+
27
+
#### How to Use Micro Codebase Export
28
+
29
+
**For the entire codebase:**
30
+
1. Open the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P` on macOS)
31
+
2. Type "CodebaseMD: Export Micro Codebase" and select it
32
+
3. Choose a location to save the exported Markdown file
33
+
34
+
**For selected files:**
35
+
1. Select one or more files or folders in the Explorer view
36
+
2. Right-click and select "CodebaseMD: Export Selected as Micro Codebase" from the context menu
37
+
3. Choose a location to save the exported Markdown file
38
+
39
+
#### Understanding the Output Format
40
+
41
+
The micro codebase representation uses a specialized notation:
0 commit comments