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
We're excited to announce the release of CodebaseMD v1.0.2!
4
+
5
+
## New Features
6
+
7
+
### .codebaseignore Support
8
+
9
+
This release adds support for a special `.codebaseignore` file that works similarly to `.gitignore` but is specifically for controlling what file contents are exported:
10
+
11
+
- Files matching patterns in `.codebaseignore` will still be included in the folder structure
12
+
- Their contents will be excluded from the export, showing "*(File content excluded by .codebaseignore)*" instead
13
+
- The `.codebaseignore` file uses the same syntax as `.gitignore`
14
+
15
+
## How to Use .codebaseignore
16
+
17
+
1. Create a `.codebaseignore` file in the root of your workspace
18
+
2. Add file patterns following standard gitignore syntax
19
+
3. Run the export command - files matching these patterns will be in the structure but their contents won't be included
20
+
21
+
Example `.codebaseignore` file:
22
+
```
23
+
# Exclude all test files
24
+
*.test.js
25
+
*.spec.js
26
+
__tests__/
27
+
28
+
# Exclude configuration files
29
+
.eslintrc
30
+
.prettierrc
31
+
tsconfig.json
32
+
33
+
# Exclude specific files or directories
34
+
src/legacy/
35
+
temp.js
36
+
```
37
+
38
+
## Installation
39
+
40
+
Download the `.vsix` file from this release and install it in VS Code:
41
+
42
+
1. Open VS Code
43
+
2. Press `Ctrl+Shift+X` to open the Extensions view
44
+
3. Click on the three dots (⋯) in the top right corner
45
+
4. Select "Install from VSIX..." and choose the downloaded file
Copy file name to clipboardExpand all lines: docs/configuration.md
+25Lines changed: 25 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,31 @@
2
2
3
3
Currently, CodebaseMD does not have user-configurable settings through the Visual Studio Code settings interface. However, you can customize some behaviors by modifying the source code directly.
4
4
5
+
## Using .codebaseignore File
6
+
7
+
CodebaseMD supports a special `.codebaseignore` file that works similarly to `.gitignore` but specifically for controlling what file contents are exported:
8
+
9
+
1. Create a `.codebaseignore` file in the root of your workspace
10
+
2. Add file patterns following the same syntax as `.gitignore`
11
+
3. Files matching these patterns will still be listed in the folder structure but their contents will be excluded from the export
12
+
13
+
Example `.codebaseignore` file:
14
+
```
15
+
# Exclude all test files
16
+
*.test.js
17
+
*.spec.js
18
+
__tests__/
19
+
20
+
# Exclude configuration files
21
+
.eslintrc
22
+
.prettierrc
23
+
tsconfig.json
24
+
25
+
# Exclude specific files or directories
26
+
src/legacy/
27
+
temp.js
28
+
```
29
+
5
30
## Customizing Ignored Files and Directories
6
31
7
32
To change which files and directories are ignored during export:
Copy file name to clipboardExpand all lines: docs/usage.md
+25-11Lines changed: 25 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,22 +1,36 @@
1
1
# Usage
2
2
3
-
CodebaseMD provides two main functionalities: exporting your entire codebase and exporting selected files or folders.
3
+
CodebaseMD provides two main commands to export your codebase to a Markdown file:
4
+
5
+
1.**Export All**: Export the entire codebase to a Markdown file
6
+
2.**Export Selected**: Export only the selected files or folders to a Markdown file
4
7
5
8
## Exporting the Entire Codebase
6
9
7
-
1. Open your project in Visual Studio Code
8
-
2. Open the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P`)
9
-
3. Search for and select "Export Codebase as Markdown"
10
+
1. Open the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P` on macOS)
11
+
2. Type "CodebaseMD: Export All" and select it
12
+
3. Choose a location to save the exported Markdown file
13
+
4. The extension will process all files in your workspace, excluding files specified in `.gitignore` or default ignore patterns
14
+
5. Once complete, you will see a notification that the file was saved successfully
15
+
16
+
## Exporting Selected Files
17
+
18
+
1. Select one or more files or folders in the Explorer view
19
+
2. Right-click and select "CodebaseMD: Export Selected" from the context menu
20
+
3. Alternatively, open the Command Palette and type "CodebaseMD: Export Selected" (you need to have selected files first)
10
21
4. Choose a location to save the exported Markdown file
11
-
5. The extension will generate a Markdown file containing your project's structure and file contents
22
+
5. The extension will process only the selected files, still respecting ignore patterns
23
+
6. Once complete, you will see a notification that the file was saved successfully
24
+
25
+
## Excluding Files from Content Export
26
+
27
+
You can exclude files from having their contents exported while still keeping them in the folder structure by using a `.codebaseignore` file:
12
28
13
-
## Exporting Selected Files or Folders
29
+
1. Create a `.codebaseignore` file in the root of your workspace
30
+
2. Add patterns using the same syntax as `.gitignore`
31
+
3. When exporting, files matching these patterns will be included in the folder structure but will show a message indicating their contents were excluded
14
32
15
-
1. In the Explorer view, select one or more files or folders you want to export
16
-
2. Right-click on the selection
17
-
3. Choose "Export Selected as Markdown" from the context menu
18
-
4. Select a location to save the exported Markdown file
19
-
5. The extension will generate a Markdown file containing the structure and contents of your selected files and folders
33
+
This is useful for files that you want to acknowledge exist in your project structure but don't need to include their full contents in the export.
We're excited to announce the release of CodebaseMD v1.0.2!
4
+
5
+
## New Features
6
+
7
+
### .codebaseignore Support
8
+
9
+
This release adds support for a special `.codebaseignore` file that works similarly to `.gitignore` but is specifically for controlling what file contents are exported:
10
+
11
+
- Files matching patterns in `.codebaseignore` will still be included in the folder structure
12
+
- Their contents will be excluded from the export, showing "*(File content excluded by .codebaseignore)*" instead
13
+
- The `.codebaseignore` file uses the same syntax as `.gitignore`
14
+
15
+
## How to Use .codebaseignore
16
+
17
+
1. Create a `.codebaseignore` file in the root of your workspace
18
+
2. Add file patterns following standard gitignore syntax
19
+
3. Run the export command - files matching these patterns will be in the structure but their contents won't be included
20
+
21
+
Example `.codebaseignore` file:
22
+
```
23
+
# Exclude all test files
24
+
*.test.js
25
+
*.spec.js
26
+
__tests__/
27
+
28
+
# Exclude configuration files
29
+
.eslintrc
30
+
.prettierrc
31
+
tsconfig.json
32
+
33
+
# Exclude specific files or directories
34
+
src/legacy/
35
+
temp.js
36
+
```
37
+
38
+
## Installation
39
+
40
+
Download the `.vsix` file from this release and install it in VS Code:
41
+
42
+
1. Open VS Code
43
+
2. Press `Ctrl+Shift+X` to open the Extensions view
44
+
3. Click on the three dots (⋯) in the top right corner
45
+
4. Select "Install from VSIX..." and choose the downloaded file
0 commit comments