https://github.com/tintoy/docfx-assistant

DocFX assistant for VS Code
https://github.com/tintoy/docfx-assistant

docfx vscode-extension

Last synced: 4 months ago
JSON representation

DocFX assistant for VS Code

• Host: GitHub
• URL: https://github.com/tintoy/docfx-assistant
• Owner: tintoy
• License: mit
• Created: 2017-08-04T06:10:48.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2018-07-23T01:18:40.000Z (almost 8 years ago)
• Last Synced: 2025-05-14T13:45:33.629Z (about 1 year ago)
• Topics: docfx, vscode-extension
• Language: TypeScript
• Size: 5.08 MB
• Stars: 2
• Watchers: 1
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# DocFX assistant

An extension for VS Code that provides tools for authoring content using Microsoft DocFX.

![DocFX Assistant in action](docs/images/DocFX-in-action.gif)

I'm [planning](https://github.com/tintoy/docfx-assistant/issues/6) to eventually contribute this functionality to Microsoft's [official DocFX extension](https://marketplace.visualstudio.com/items?itemName=docfxsvc.DocFXPreview), but you're welcome to use this in the meanwhile.

## Usage

When you're editing Markdown or YAML and the workspace contains a DocFX project, type `@` or press `ctrl+space` to invoke the completion provider and bring up a pick-list of available topic UIDs.

It will also underline inline-style and (`@xxx`) and XRef-style (``) links for UIDs into hyperlinks pointing to the documents where they are defined. If a link is not underlined, then it points to a non-existent topic.

To refresh the list of available topics, use the "DocFX: Refresh topic UIDs" command.

## Installation

You can install this extension from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=tintoy.docfx-assistant).

## Notes

This extension uses [docfx-project](https://www.npmjs.com/package/docfx-project) to work with DocFX projects and their content files.

Unless configured otherwise, it will automatically start scanning and updating in the background as soon as it starts (or you open a workspace with `docfx.json` in the root directory). Note that if your `docfx.json` file is in a sub-folder, the extension will not activate until you first invoke one of its commands. 

You may want to exclude `/.vscode/docfx-assistant` from source control (sorry, we can't do this automatically).

## Questions / bug reports

If you have questions, feature requests, or would like to report a bug, please feel free to reach out by creating an issue. When reporting a bug, please try to include as much information as possible about what you were doing at the time, what you expected to happen, and what actually happened.

If you're interested in collaborating that'd be great, too :-)