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/adding-projects.md
+40-24Lines changed: 40 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,42 +38,58 @@ Here's an example `context7.json` file with all available options:
38
38
39
39
> **💡 Pro Tip**: Including the `$schema` field enables autocomplete, validation, and helpful tooltips in modern code editors like VS Code, making it easier to create and maintain your configuration.
40
40
41
-
####Field Descriptions
41
+
## Field Descriptions
42
42
43
-
-**`projectTitle`** (string): Suggested display name for your project in Context7. Only used when LLM can not generate a name with high confidence.
43
+
-**`projectTitle`** (string): Suggested display name for your project in Context7. Only used when LLM
44
+
can not generate a name with high confidence.
44
45
45
-
-**`description`** (string): Suggested description for your project in Context7. Only used when LLM can not generate a name with high confidence.
46
+
-**`description`** (string): Suggested description for your project in Context7. Only used when LLM can
47
+
not generate a name with high confidence.
46
48
47
-
-**`branch`** (string): The name of the git branch to parse. If not provided, the default branch will be used.
49
+
-**`branch`** (string): The name of the git branch to parse. If not provided, the default branch will
50
+
be used.
48
51
49
-
-**`folders`** (array): Specific folder paths to include when parsing documentation. If empty, Context7 will scan the entire repository for relevant documentation files. Supports regex patterns and requires full paths.
52
+
-**`folders`** (array): Specific folder paths to include when parsing documentation. If empty, Context7
53
+
will scan the entire repository for relevant documentation files. Note: Root-level markdown files are
54
+
always included regardless of this setting.
50
55
51
-
-**`excludeFolders`** (array): Folder paths to exclude from documentation parsing. Useful for excluding source code directories, build folders, or other non-documentation content. Supports regex patterns and requires full paths.
56
+
-**`excludeFolders`** (array): Patterns to exclude folders and paths from documentation parsing.
57
+
Supports simple names, paths, and glob patterns (see Exclusion Patterns section below).
52
58
53
-
-**`excludeFiles`** (array): Specific file names to exclude from documentation parsing. Only include the filename (not the path). Useful for excluding files like `CHANGELOG.md`, license files, or other non-documentation content that might not be relevant for coding agents. Regex patterns are not supported.
59
+
-**`excludeFiles`** (array): Specific file names to exclude from documentation parsing. Only include
60
+
the filename (not the path). Useful for excluding files like `CHANGELOG.md`, license files, or other
61
+
non-documentation content.
54
62
55
-
-**`rules`** (array): Best practices or important guidelines that coding agents should follow when using your library. These appear as recommendations in the documentation context provided to coding agents.
63
+
-**`rules`** (array): Best practices or important guidelines that coding agents should follow when
64
+
using your library. These appear as recommendations in the documentation context provided to coding
65
+
agents.
56
66
57
-
-**`previousVersions`** (array): Information about previous versions of your library that should also be available in Context7.
58
-
-**`tag`**: The Git tag or version identifier
59
-
-**`title`**: Human-readable version name
60
-
67
+
-**`previousVersions`** (array): Information about previous versions of your library that should also
68
+
be available in Context7.
69
+
-**`tag`**: The Git tag or version identifier
70
+
-**`title`**: Human-readable version name
61
71
62
-
### Exclusion Patterns:
63
72
64
-
The `excludeFolders` parameter supports various pattern types for flexible exclusion:
73
+
### Exclusion Patterns
65
74
66
-
-**Simple folder names**: `"node_modules"` - Excludes any folder named "node_modules" anywhere in the tree
67
-
-**Path patterns**: `"app-sdk/v2.3"` - Excludes specific paths and everything under them
68
-
-**Glob patterns**: `"*.test"`, `"temp*"` - Excludes folders matching the pattern
0 commit comments