Sensedia Docs Helper is a Visual Studio Code extension that improves the Sensedia Docs authoring experience. It provides a webview-based preview so you can render and review documentation directly inside the editor.
Features
Markdown Preview: Render markdown files in a dedicated webview.
Swagger UI Integration: Display API reference content directly in the preview.
Custom Components: Support custom React components used in Sensedia Docs content.
How to Use
Install the extension from the Visual Studio Code Marketplace.
Open a markdown file related to Sensedia Docs.
Open the Command Palette with Ctrl+Shift+P and run Sensedia Docs: Live Preview.
The extension will open a preview panel beside the editor and render the markdown content, including supported custom components and Swagger content.
This is an unofficial Sensedia Docs extension created as a personal project to support the documentation workflow.
Development
Clone the repository.
Install the root dependencies with pnpm install.
Install the webview dependencies with cd webview-ui && pnpm install.
Build the webview with pnpm run build:webview.
Compile the extension with pnpm run compile.
Press F5 in VS Code to launch the Extension Development Host.
Whenever you change code inside webview-ui, rebuild the webview bundle and recompile the extension before testing the changes in VS Code.
Publishing
Update the version in package.json.
Run vsce package to generate the extension package.
Publish the new version to the Visual Studio Code Marketplace.
