This project is a Visual Studio Code extension designed to enhance the documentation experience for Sensedia Docs. It provides a webview interface that allows users to preview and interact with API documentation directly within the editor.
Features
Markdown Preview: View and interact with markdown files in a user-friendly webview.
Swagger UI Integration: Display Swagger documentation for APIs directly in the preview.
Custom Components: Use custom React components for rendering markdown content.
How to Use
Install the extension from the Visual Studio Code marketplace.
Open a markdown file related to Sensedia Docs.
Use the command palette to open the markdown preview. (Ctrl+Shift+P and type "Sensedia Docs: Open").
The preview will render the markdown content along with any associated Swagger documentation.
Ps*: Non official Sensedia Docs extension, but a personal project to help with the documentation process.
Development
To contribute or modify the extension, follow these steps:
Clone the repository.
Install dependencies using pnpm install.
Compile the TypeScript code using pnpm run compile.
Launch the extension in a new VS Code window using the debugger.
Make your changes in webview-ui and run pnpm run build:webview && pnpm run compile to update the webview bundle.
Whenever you make changes to the webview code, remember to rebuild the webview bundle and recompile the extension code to see the updates in action.
Publishing
To publish a new version of the extension:
Update the version number in package.json.
Run vsce package to publish the new version to the marketplace.
Open the vscode marketplace page for the extension to verify the update.
