Workspace Wiki

https://marketplace.visualstudio.com/items?itemName=alexjsully.workspace-wiki
Admin
Workspace Wiki is a VS Code extension that scans your workspace for documentation files and presents...
Tokens:1,953
Snippets:32
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Configure File Opening Modes

Source: https://marketplace.visualstudio.com/items?itemName=alexjsully.workspace-wiki/index_itemName=alexjsully.workspace-wiki

Defines the default behavior for opening files from the Workspace Wiki tree. Supported modes are 'preview' for quick viewing and 'editor' for full editing within VS Code.

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

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

### Configure Auto-Reveal Delay

Source: https://marketplace.visualstudio.com/items?itemName=alexjsully.workspace-wiki/index_itemName=alexjsully.workspace-wiki

Sets the delay in milliseconds before the Workspace Wiki tree automatically reveals the currently active file when the editor focus changes. This helps in locating the active document within the extensive file structure.

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

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

### Configure Directory Sorting

Source: https://marketplace.visualstudio.com/items?itemName=alexjsully.workspace-wiki/index_itemName=alexjsully.workspace-wiki

Determines the sorting order of files and folders within each directory in the Workspace Wiki tree. Options include 'files-first', 'folders-first', and 'alphabetical' for predictable navigation.

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

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

### Configure Supported File Extensions

Source: https://marketplace.visualstudio.com/items?itemName=alexjsully.workspace-wiki/index_itemName=alexjsully.workspace-wiki

Specifies the file extensions that the Workspace Wiki extension should scan and include in its tree view. This setting allows customization of which documentation file types are indexed. Special handling is provided for README files when 'md' or 'markdown' are included.

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

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

### Configure Acronym Casing Preservation

Source: https://marketplace.visualstudio.com/items?itemName=alexjsully.workspace-wiki/index_itemName=alexjsully.workspace-wiki

Lists acronyms for which the Workspace Wiki should preserve specific casing in generated 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 Maximum Search Depth

Source: https://marketplace.visualstudio.com/items?itemName=alexjsully.workspace-wiki/index_itemName=alexjsully.workspace-wiki

Sets the maximum depth of subdirectories to scan for documentation files. This setting helps manage performance in large repositories by limiting the scope of the file search.

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

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

### Configure Excluded File Glob Patterns

Source: https://marketplace.visualstudio.com/items?itemName=alexjsully.workspace-wiki/index_itemName=alexjsully.workspace-wiki

Defines glob patterns for files and directories that should be excluded from the Workspace Wiki scan. This is useful for ignoring generated files, dependencies, or build artifacts.

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