Workspace Wiki

https://open-vsx.org/extension/alexjsully/workspace-wiki
Admin
Workspace Wiki is a VS Code extension that scans your workspace for documentation files and presents...
Tokens:1,918
Snippets:33
Trust Score:9.4
Update:10 months ago
Show doc for...
Tokens:
Raw
### Configure Custom Commands for Opening Files in Workspace Wiki

Source: https://open-vsx.org/extension/alexjsully/workspace-wiki/index

Allows customization of how different file types are opened within VS Code using Workspace Wiki. You can associate specific commands, including those from other extensions, for specialized previews or editing actions.

```json
{
	"workspaceWiki.openWith": {
		"md": "markdown.showPreview",
		"markdown": "markdown.showPreview",
		"txt": "vscode.open",
		"pdf": "vscode.open",
		"html": "otherExtension.preview"
	}
}
```

--------------------------------

### Configure Auto-Reveal Delay for Active File in Workspace Wiki

Source: https://open-vsx.org/extension/alexjsully/workspace-wiki/index

Sets the delay in milliseconds before the Workspace Wiki extension automatically reveals the currently active file in the tree view. This setting can be adjusted to control the responsiveness of the auto-reveal feature.

```json
{
	"workspaceWiki.autoRevealDelay": 1000
}
```

--------------------------------

### Configure Directory Sorting for Workspace Wiki

Source: https://open-vsx.org/extension/alexjsully/workspace-wiki/index

Determines the sorting order of files and folders within directories in the Workspace Wiki tree view. Options include sorting files first, folders first, or alphabetically.

```json
{
	"workspaceWiki.directorySort": "folders-first"
}
```

--------------------------------

### Configure Maximum Search Depth for Workspace Wiki

Source: https://open-vsx.org/extension/alexjsully/workspace-wiki/index

Sets the maximum folder depth the Workspace Wiki extension will scan for documentation files. Adjusting this value can optimize performance in large repositories.

```json
{
	"workspaceWiki.maxSearchDepth": 15
}
```

--------------------------------

### Configure Supported File Extensions for Workspace Wiki

Source: https://open-vsx.org/extension/alexjsully/workspace-wiki/index

Defines which file extensions the Workspace Wiki extension should include in its scan. You can specify custom extensions like 'html' or 'pdf'. If 'md' or 'markdown' is included, README files (case-insensitive, no extension) are automatically included and treated as Markdown.

```json
{
	"workspaceWiki.supportedExtensions": ["md", "markdown", "txt", "html", "pdf"]
}
```

--------------------------------

### Configure Acronym Casing Preservation in Workspace Wiki Titles

Source: https://open-vsx.org/extension/alexjsully/workspace-wiki/index

Specifies an array of acronyms for which the Workspace Wiki extension should preserve proper casing when generating file titles. This ensures technical terms like HTML, CSS, and API are displayed correctly.

```json
{
	"workspaceWiki.acronymCasing": [
		"HTML",
		"CSS",
		"JS",
		"TS",
		"API",
		"URL",
		"JSON",
		"XML",
		"HTTP",
		"HTTPS",
		"REST",
		"SQL",
		"CSV",
		"FHIR",
		"BFF",
		"MFE",
		"PDF",
		"VSC"
	]
}
```

--------------------------------

### Configure Exclude Globs for Workspace Wiki File Scanning

Source: https://open-vsx.org/extension/alexjsully/workspace-wiki/index

Specifies glob patterns to exclude specific files and directories from the Workspace Wiki scan. This is useful for ignoring build artifacts, temporary files, or version control directories like node_modules or .git.

```json
{
	"workspaceWiki.excludeGlobs": [
		"**/node_modules/**",
		"**/.git/**",
		"**/dist/**",
		"**/build/**",
		"**/coverage/**",
		"**/.next/**"
	]
}
```
Tokens:
Raw