https://github.com/ivirtex/vulkan-hover-docs

Project providing Vulkan API Reference for VS Code
https://github.com/ivirtex/vulkan-hover-docs

vscode vscode-extension vulkan vulkan-api

Last synced: 10 days ago
JSON representation

Project providing Vulkan API Reference for VS Code

• Host: GitHub
• URL: https://github.com/ivirtex/vulkan-hover-docs
• Owner: ivirtex
• Created: 2024-05-13T23:59:51.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2025-11-08T22:21:26.000Z (3 months ago)
• Last Synced: 2025-11-09T00:13:28.148Z (3 months ago)
• Topics: vscode, vscode-extension, vulkan, vulkan-api
• Language: Go
• Homepage: https://marketplace.visualstudio.com/items?itemName=ivirtex.vulkan-hover-docs
• Size: 10.3 MB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Vulkan Hover Docs

This repo consists of 2 projects:

- **docs_generator**, which is a small CLI written in Go for scraping, converting and post-processing HTML pages from Khronos registry.

- **vscode_extension**, which is an VS Code extension that matches Vulkan symbols in the editor to Markdown pages generated by `docs_generator`.

### Example

![preview](https://github.com/ivirtex/vulkan-hover-docs/blob/master/vscode_extension/images/screenshot.png?raw=true)

## Motivation

If you have ever wrote something in Vulkan, you probably know how verbose and extensive this API is.  

For me, going back and forth to the documentation was pretty annoying and time consuming, that's why I created this project to help others with learning and using Vulkan.