-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
chore(blog): add asyncapi vscode preview goes web now available in your browser 🚀 #4484
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Ruchip16
wants to merge
17
commits into
asyncapi:master
Choose a base branch
from
Ruchip16:new_blog
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+59
−0
Open
Changes from all commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
edbba5c
new blog
Ruchip16 995404d
address review comments
Ruchip16 633b7e4
nitpick comment fix
Ruchip16 ecbae18
fix review comments
Ruchip16 2cd84a2
fix review comments
Ruchip16 03c23c0
fix coderabbit comments
Ruchip16 c204103
fix coderabbit comments
Ruchip16 2095d94
update
Ruchip16 af79e46
fix ci
Ruchip16 d490f84
fix code rabbit comment
Ruchip16 84672f4
fix code rabbit comment
Ruchip16 c4996d4
review comments
Ruchip16 666e9f4
update youtube link
Ruchip16 e1b69c7
Merge branch 'master' into new_blog
Ruchip16 483be7c
Merge branch 'master' into new_blog
princerajpoot20 4ce8bf0
Merge branch 'master' into new_blog
Ruchip16 6f648be
Merge branch 'master' into new_blog
princerajpoot20 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| --- | ||
| title: 'AsyncAPI VS Code Preview Goes Web: Now Available in Your Browser' | ||
| date: 2025-12-07T06:00:00+01:00 | ||
| type: Community | ||
| tags: | ||
| - vscode-extension | ||
| - webview | ||
| cover: /img/posts/vs-asyncapi-preview/image.webp | ||
| authors: | ||
| - name: Ruchi Pakhle | ||
| photo: /img/avatars/ruchip16.webp | ||
| link: https://twitter.com/Ruchicodess | ||
| byline: AsyncAPI Maintainer & TSC Member | ||
| excerpt: 'AsyncAPI VS Code Preview extension is now web-compatible. Preview AsyncAPI files directly in your browser using vscode.dev or github.dev.' | ||
| --- | ||
|
|
||
| For years, the AsyncAPI VS Code Preview extension has been helping developers visualize and work with AsyncAPI documents directly inside VS Code. But there was always one limitation: you needed VS Code installed on your machine. | ||
|
|
||
| Not anymore! We've made the extension fully web-compatible, which means you can now open any GitHub repository in vscode.dev or github.dev and instantly preview AsyncAPI files right in your browser. No downloads, no local setup – just open and preview. | ||
Ruchip16 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ## What Changed Under the Hood? | ||
|
|
||
| Making the extension web-compatible required some technical changes: | ||
|
|
||
| - **Introduced lightweight browser utilities** like `pathUtils` for cross-platform file handling | ||
| - **Updated VS Code dependencies** (`vscode` and `@types/vscode`) to ensure web extension compatibility | ||
| - **Removed Node.js-specific modules** like `fs`, `path`, and other dependencies that don't work in browsers | ||
| - **Removed EDAVisualizer integration** since it's unmaintained and incompatible with web mode | ||
|
|
||
| ## Why This Is a Big Deal | ||
|
|
||
| This change removes a major friction point for AsyncAPI adoption. Think about it: how many times have you wanted to quickly check an AsyncAPI file in a GitHub repo but didn't want to go through the hassle of cloning it locally? | ||
|
|
||
| Now contributors can review specs directly on GitHub, teams working in cloud-first environments don't need local VS Code installations, and newcomers can experiment with AsyncAPI without any setup. It's especially useful for open-source maintainers who spend a lot of time reviewing specs in pull requests. | ||
|
|
||
|
|
||
| ## Demo | ||
|
|
||
| Watch the AsyncAPI VS Code Preview extension working seamlessly in your web browser. This demonstration shows how to install the extension in VS Code web, open an AsyncAPI document, and use the preview functionality to render beautiful documentation directly in the browser without needing a local VS Code installation. | ||
|
|
||
| **Demo Overview:** The video demonstrates opening a GitHub repository in vscode.dev, installing the AsyncAPI Preview extension, opening a sample AsyncAPI YAML file, and executing the preview command to generate interactive documentation in the web browser. | ||
Ruchip16 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| <YouTube id="DlqqYs3PmJtROTvF" /> | ||
|
|
||
| **Accessibility Note:** This video includes visual demonstrations of the AsyncAPI extension interface. For a text-based description of the steps shown, please refer to the "Try It Out" section below. | ||
|
|
||
| ## Looking Forward | ||
|
|
||
| This web compatibility opens up some interesting possibilities we hadn't considered before. Educators can now easily demonstrate AsyncAPI concepts without asking students to install anything. Open-source projects get more contributors because the barrier to reviewing and understanding specs is much lower. Remote teams can collaborate on AsyncAPI files without worrying about everyone having the same local setup. | ||
|
|
||
| ## Maintenance Mode | ||
|
|
||
| A quick note: this extension is now in maintenance mode. We'll keep it working and updated, but we're not planning major new features. That said, if you run into bugs or have ideas for improvements, community contributions are always welcome! | ||
|
|
||
| ## Try It Out | ||
|
|
||
| If you want to see this in action, head over to [vscode.dev](https://vscode.dev) and open any repo with AsyncAPI files. Install the AsyncAPI Preview extension, open a `.yaml` or `.json` file, and run "AsyncAPI: Preview Document" from the Command Palette. You'll have beautiful rendered docs in seconds. | ||
|
|
||
| We'd love to hear how this works for you! Drop by the [AsyncAPI community Slack](https://www.asyncapi.com/slack-invite) and let us know if you find any issues or have suggestions for improvements. | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.