Skip to content

Repository files navigation

Docs Panel

Browse your project's markdown docs from a dedicated panel in the Activity Bar, without hunting through the file tree.

Features

  • A dedicated Docs view in the Activity Bar listing every markdown file found in your configured docs folder(s).
  • Click a file to open it in VS Code's built-in Markdown Preview as a new tab.
  • Scan multiple locations at once via a comma-separated path list.
  • Two path modes per entry:
    • Anchored (docs or /docs) — only that exact folder, relative to the workspace root.
    • Recursive (**/docs) — search the entire workspace for every folder with that name (handy in monorepos).
  • Results are automatically organized: files are grouped by parent folder name (or by docs location, when multiple are found) only when there's more than one group — otherwise you just get a flat list.
  • Optionally skip dot-prefixed "private" files and folders (.drafts, .obsidian, etc.).
  • The panel refreshes automatically as matching files and folders are added, removed, or changed.

Extension Settings

This extension contributes the following settings:

Setting Default Description
docsPanel.docsPath **/docs Path to the docs folder, relative to the workspace root. Accepts a comma-separated list to scan several locations.
docsPanel.skipPrivate true Skip files and folders whose name starts with a dot (e.g. .obsidian, .draft.md) when scanning for docs.

docsPanel.docsPath examples

Value Behavior
docs Only the docs folder directly under the workspace root.
**/docs Every folder named docs anywhere in the workspace.
docs, legacy/docs Two specific, anchored locations.
**/docs, **/guides Every folder named docs or guides anywhere in the workspace.

Commands

  • Docs Panel: Refresh — manually re-scan for markdown files.
  • Docs Panel: Open Settings — jump straight to the docsPanel.docsPath setting.

Requirements

None beyond VS Code 1.85.0 or newer.

Release Notes

See CHANGELOG.md.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages