DocFxExtension

DocFxExtension is a VS Code extension that brings fast knowledge-graph navigation, UID-based cross-references, and structured note management to DocFX documentation projects.

Features

• Lookup / Create Note (Ctrl+L / Cmd+L) — fuzzy-find or create notes by UID using Dendron-style segment-prefix matching
• Rename Note — rename a note and update all cross-references
• Delete Note — delete a note and clean up references
• Show Backlinks — sidebar panel showing all notes referencing the active document
• Knowledge Tree — sidebar webview of your DocFX content hierarchy with drag-to-reorder and inline node actions (rename, delete, new child)
• New Child Document — add a Page, Folder, or Topic node from the tree
• Outline — markdown heading tree for the active document
• TOC auto-sync — toc.yml is updated automatically on every create/move/delete
• Fix & Complete toc.yml — right-click a toc.yml file or folder in the Explorer to remove stale entries and append missing .md files and sub-folder toc references; a Recursive variant walks the entire toc subtree

Requirements

A workspace containing a docfx.json file at the root.

Installation

Quick install (latest release)

VSIX_URL=$(curl -s https://api.github.com/repos/WiseTechGlobal/DocFxExtension/releases/latest \
  | grep "browser_download_url.*\.vsix" | cut -d '"' -f 4) \
  && curl -L "$VSIX_URL" -o docfx-extension.vsix \
  && code --install-extension docfx-extension.vsix

If jq is available, replace the grep | cut pipe with:

VSIX_URL=$(curl -s https://api.github.com/repos/WiseTechGlobal/DocFxExtension/releases/latest \
  | jq -r '.assets[] | select(.name | endswith(".vsix")) | .browser_download_url') \
  && curl -L "$VSIX_URL" -o docfx-extension.vsix \
  && code --install-extension docfx-extension.vsix

Manual install from GitHub Releases

1. Go to Releases
2. Download docfx-extension-vX.Y.Z.vsix from the latest release
3. In VS Code: Extensions panel → ⋯ → Install from VSIX → select the file
4. Reload VS Code

Extension Settings

No settings currently.

License

MIT