1// Copyright 2018-2023 The Khronos Group Inc.
2//
3// SPDX-License-Identifier: CC-BY-4.0
4
5ifdef::env-github[]
6:note-caption: :information_source:
7endif::[]
8
9= Index Building For Vulkan Chunked HTML Output
10
11This directory contains scripts which help a search index, and add a
12searchbox using this index into each page of the Vulkan chunked HTML
13specification output. These files include:
14
15[options="compact"]
16  * README.adoc - this file
17  * build-index.js - build a JSON search index from generate-index.rb output
18  * chunked.css - CSS for the searchbox
19  * chunked.js - Script to load and execute the searchbox
20  * custom.patch - Patch to generated HTML to include chunked.js / chunked.css
21  * generate-index.rb - generate an index of the HTML documents
22  * lunr.js - utility functions taken from the lunr package
23
24= Credits and Licenses
25
26The indexing tools and toolchain was created by Baldur Karlsson in
27    https://github.com/baldurk/vkdocs-chunked-builder
28Files created in that project are under the Apache 2.0 license.
29
30Portions of the chunked.js script are taken from
31    https://github.com/filamentgroup/loadJS/blob/master/loadJS.js
32These portions are copyright Scott Jehl, Filament Group, Inc., under an MIT
33license.
34
35The lunr.js script is taken from the 'lunr' npm package, version 2.3.8. It
36is copyright Oliver Nightingale, under an MIT license.
37