{"id":13728222,"url":"https://github.com/KhronosGroup/Vulkan-Docs","last_synced_at":"2025-05-08T00:31:28.627Z","repository":{"id":37549355,"uuid":"51506618","full_name":"KhronosGroup/Vulkan-Docs","owner":"KhronosGroup","description":"The Vulkan API Specification and related tools","archived":false,"fork":false,"pushed_at":"2024-11-02T07:54:48.000Z","size":43642,"stargazers_count":2800,"open_issues_count":366,"forks_count":468,"subscribers_count":222,"default_branch":"main","last_synced_at":"2024-11-04T17:25:32.298Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/KhronosGroup.png","metadata":{"files":{"readme":"README.adoc","changelog":"ChangeLog.adoc","contributing":"CONTRIBUTING.adoc","funding":null,"license":"COPYING.adoc","code_of_conduct":"CODE_OF_CONDUCT.adoc","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-02-11T10:03:55.000Z","updated_at":"2024-11-04T15:23:20.000Z","dependencies_parsed_at":"2024-01-05T12:42:46.977Z","dependency_job_id":"2fdd0395-9ad2-4175-927e-36a62bbf208b","html_url":"https://github.com/KhronosGroup/Vulkan-Docs","commit_stats":null,"previous_names":[],"tags_count":319,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KhronosGroup%2FVulkan-Docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KhronosGroup%2FVulkan-Docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KhronosGroup%2FVulkan-Docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KhronosGroup%2FVulkan-Docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KhronosGroup","download_url":"https://codeload.github.com/KhronosGroup/Vulkan-Docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224115711,"owners_count":17258238,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-03T02:00:38.811Z","updated_at":"2024-11-14T19:30:51.595Z","avatar_url":"https://github.com/KhronosGroup.png","language":"JavaScript","readme":"// Copyright 2017-2024 The Khronos Group Inc.\n// SPDX-License-Identifier: CC-BY-4.0\n\nifdef::env-github[]\n:note-caption: :information_source:\nendif::[]\n\n= Vulkan^(R)^ and Vulkan^(R)^ SC API Documentation Project\n\nFor Vulkan^(R)^ API specific documentation see link:READMEVK.adoc[READMEVK.adoc]\n\nFor Vulkan^(R)^ SC API specific documentation see link:READMESC.adoc[READMESC.adoc]\n\n== Directory Structure\n\nThe directory structure is as follows:\n\n```\nREADME.adoc           This file\nREADMESC.adoc         Readme for the Vulkan SC specification\nREADMEVK.adoc         Readme for the Vulkan specification\nBUILD.adoc            Documents how to build the specifications and reference pages\nCONTRIBUTING.adoc     Requirements for external contributions to the repository\nCOPYING.adoc          Copyright and licensing information\nCODE_OF_CONDUCT.adoc  Code of Conduct\nLICENSE.adoc          Summary of licenses used by files in the repository\nChangeLog.adoc        Change log summary for each public Vulkan spec update\nChangeLogSC.adoc      Change log summary for each public Vulkan SC spec update\nMakefile, make*       Makefile and helper build scripts (see BUILD.adoc)\nantora/               Staging area for the docs.vulkan.org Antora 'proposals' and 'spec' modules\nappendices/           Specification appendices\nchapters/             Specification chapters\nproposals/            Design documents for extensions\nconfig/               Asciidoctor configuration, CSS, and index generator\nimages/               Images (figures, diagrams, icons)\ngen/out/              Default directory for the generated documents\nscripts/              Helper scripts used in specification, header, and reference page generation\nstyle/                Sources for \"styleguide\" (Vulkan Documentation and Extensions: Procedures and Conventions)\nxml/                  XML API Registry (`vk.xml`) as well as XML for non-Vulkan\n                      data structures used with Video extensions (`video.xml`)\nregistry.adoc         Source for documentation of the XML format\n```\n\n\n== Building the Specification and Reference Pages\n\nThe document sources are marked up in Asciidoctor format, and we use\n`asciidoctor` and related toolchain components to generate output documents.\nSee link:BUILD.adoc[BUILD.adoc] for more information on installing the\ntoolchain and building the Specification.\n\n\n== Generating Headers and Related Files\n\nSee link:xml/README.adoc[xml/README.adoc].\n\nThe header files (`include/vulkan/vulkan*.h`) and many parts of the\nspecification and reference page documents are generated from descriptions\nin the XML API Registry (link:xml/vk.xml[`xml/vk.xml`]).\nThe generated files are not checked into the repository.\nIf you change `vk.xml`, you can regenerate the headers by going into\n`xml/` and running:\n\n    $ make clean install\n\nThe other generated files are built as required via dependencies in\nthe top-level `Makefile`.\n\n","funding_links":[],"categories":["Vulkan Learning Resources","JavaScript","Graphics"],"sub_categories":["VS Code Extensions for Developer Productivity","Enable Proton in Steam"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FKhronosGroup%2FVulkan-Docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FKhronosGroup%2FVulkan-Docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FKhronosGroup%2FVulkan-Docs/lists"}