Skip to content

Commit 696ddb3

Browse files
Launch (#20)
* Add reuse and related files * Removed mention of CLA from CONTRIBUTING * Update from feedback * Adjust text background on getting started banner * Fix Editor Extension buttons in Tools * Remove getting started banner background * Remove bsky social * Try fix. * try * Fix build errors on Jekyll 3.2 * fix * remove empty doc entry * Update discord link. --------- Co-authored-by: James Riordon <jriordon@outofcontrol.ca>
1 parent f6f07c3 commit 696ddb3

File tree

288 files changed

+16366
-1323
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

288 files changed

+16366
-1323
lines changed

.reuse/dep5

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
2+
Upstream-Name: Shader Slang Website
3+
Upstream-Contact: The Khronos Group, Inc.
4+
Source: https://github.com/shader-slang/shader-slang.github.io
5+
6+
Files: *
7+
Copyright: 2024 The Khronos Group, Inc.
8+
License: CC-BY-4.0
9+
10+
Files: _sass/bootstrap/*
11+
Copyright: 2011-2024 The Bootstrap Authors
12+
License: MIT
13+
14+
Files: assets/fonts/*
15+
Copyright: The Poppins Project Authors
16+
The Chivo Project Authors
17+
License: OFL-1.1
18+

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
A reminder that this issue tracker is managed by the Khronos Group. Interactions here should follow the Khronos Code of Conduct ([https://www.khronos.org/about/code-of-conduct](https://www.khronos.org/about/code-of-conduct)), which prohibits aggressive or derogatory language. Please keep the discussion friendly and civil.

CONTRIBUTING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Contributing
2+
3+
This project welcomes contributions and suggestions.

LICENSE

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
SPDX-License-Identifier: CC-BY-4.0
2+
3+
Creative Commons Attribution 4.0 International
4+
5+
Creative Commons Corporation ("Creative Commons") is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an "as-is" basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible.
6+
7+
Using Creative Commons Public Licenses
8+
9+
Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses.
10+
11+
Considerations for licensors: Our public licenses are intended for use by those authorized to give the public permission to use material in ways otherwise restricted by copyright and certain other rights. Our licenses are irrevocable. Licensors should read and understand the terms and conditions of the license they choose before applying it. Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the material as expected. Licensors should clearly mark any material not subject to the license. This includes other CC-licensed material, or material used under an exception or limitation to copyright. More considerations for licensors : wiki.creativecommons.org/Considerations_for_licensors
12+
13+
Considerations for the public: By using one of our public licenses, a licensor grants the public permission to use the licensed material under specified terms and conditions. If the licensor's permission is not necessary for any reason–for example, because of any applicable exception or limitation to copyright–then that use is not regulated by the license. Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. Use of the licensed material may still be restricted for other reasons, including because others have copyright or other rights in the material. A licensor may make special requests, such as asking that all changes be marked or described. Although not required by our licenses, you are encouraged to respect those requests where reasonable. More considerations for the public : wiki.creativecommons.org/Considerations_for_licensees

LICENSES/CC-BY-4.0.txt

Lines changed: 156 additions & 0 deletions
Large diffs are not rendered by default.

LICENSES/MIT.txt

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
MIT License
2+
3+
Copyright (c) <year> <copyright holders>
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
6+
7+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8+
9+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

LICENSES/OFL-1.1.txt

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
SIL OPEN FONT LICENSE
2+
3+
Version 1.1 - 26 February 2007
4+
5+
PREAMBLE
6+
7+
The goals of the Open Font License (OFL) are to stimulate worldwide development of collaborative font projects, to support the font creation efforts of academic and linguistic communities, and to provide a free and open framework in which fonts may be shared and improved in partnership with others.
8+
9+
The OFL allows the licensed fonts to be used, studied, modified and redistributed freely as long as they are not sold by themselves. The fonts, including any derivative works, can be bundled, embedded, redistributed and/or sold with any software provided that any reserved names are not used by derivative works. The fonts and derivatives, however, cannot be released under any other type of license. The requirement for fonts to remain under this license does not apply to any document created using the fonts or their derivatives.
10+
11+
DEFINITIONS
12+
13+
"Font Software" refers to the set of files released by the Copyright Holder(s) under this license and clearly marked as such. This may include source files, build scripts and documentation.
14+
15+
"Reserved Font Name" refers to any names specified as such after the copyright statement(s).
16+
17+
"Original Version" refers to the collection of Font Software components as distributed by the Copyright Holder(s).
18+
19+
"Modified Version" refers to any derivative made by adding to, deleting, or substituting — in part or in whole — any of the components of the Original Version, by changing formats or by porting the Font Software to a new environment.
20+
21+
"Author" refers to any designer, engineer, programmer, technical writer or other person who contributed to the Font Software.
22+
23+
PERMISSION & CONDITIONS
24+
25+
Permission is hereby granted, free of charge, to any person obtaining a copy of the Font Software, to use, study, copy, merge, embed, modify, redistribute, and sell modified and unmodified copies of the Font Software, subject to the following conditions:
26+
27+
1) Neither the Font Software nor any of its individual components, in Original or Modified Versions, may be sold by itself.
28+
29+
2) Original or Modified Versions of the Font Software may be bundled, redistributed and/or sold with any software, provided that each copy contains the above copyright notice and this license. These can be included either as stand-alone text files, human-readable headers or in the appropriate machine-readable metadata fields within text or binary files as long as those fields can be easily viewed by the user.
30+
31+
3) No Modified Version of the Font Software may use the Reserved Font Name(s) unless explicit written permission is granted by the corresponding Copyright Holder. This restriction only applies to the primary font name as presented to the users.
32+
33+
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font Software shall not be used to promote, endorse or advertise any Modified Version, except to acknowledge the contribution(s) of the Copyright Holder(s) and the Author(s) or with their explicit written permission.
34+
35+
5) The Font Software, modified or unmodified, in part or in whole, must be distributed entirely under this license, and must not be distributed under any other license. The requirement for fonts to remain under this license does not apply to any document created using the Font Software.
36+
37+
TERMINATION
38+
39+
This license becomes null and void if any of the above conditions are not met.
40+
41+
DISCLAIMER
42+
43+
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM OTHER DEALINGS IN THE FONT SOFTWARE.

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Shader-Slang.com website
2+
3+
This theme is losely based on the Serif theme for Jekyll by [Zerostatic Themes](https://www.zerostatic.io).
4+
5+
## Installation
6+
7+
### Installing Ruby & Jekyll
8+
9+
If this is your first time using Jekyll, please follow the [Jekyll docs](https://jekyllrb.com/docs/installation/) and make sure your local environment (including Ruby) is setup correctly.
10+
11+
### Installing Theme
12+
13+
Download or clone the theme.
14+
15+
To run the theme locally, navigate to the theme directory and run:
16+
17+
```
18+
bundle install
19+
```
20+
21+
To start the Jekyll local development server.
22+
23+
```
24+
bundle exec jekyll serve
25+
```
26+
27+
To build the theme.
28+
29+
```
30+
bundle exec jekyll build
31+
```
32+
33+
### Github Pages
34+
35+
This theme has been tested to work with Github Pages (and Github Project Pages). When using Github Pages you will need to update the `baseurl` in the `_config.yml` otherwise all the css, images and paths will be broken.
36+
37+
For example the site https://shader-slang.com would have `baseurl: "/"`
38+

_config.yml

100644100755
Lines changed: 48 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,48 @@
1-
theme: jekyll-theme-tactile
2-
title: The Slang Programming Language
3-
description: Productivity and performance for real-time graphics developers
1+
baseurl: '/'
2+
permalink: pretty
3+
title: 'Shader Slang'
4+
5+
logo:
6+
mobile: "images/logo/slang-logo.svg"
7+
mobile_height: "55px"
8+
mobile_width: "180px"
9+
desktop: "images/logo/slang-logo.svg"
10+
desktop_height: "55px"
11+
desktop_width: "180px"
12+
13+
14+
collections:
15+
posts:
16+
output: true
17+
events:
18+
output: true
19+
20+
defaults:
21+
- scope:
22+
path: ""
23+
type: "services"
24+
values:
25+
layout: "service"
26+
- scope:
27+
path: ""
28+
type: "team"
29+
values:
30+
layout: "team"
31+
32+
sass:
33+
style: compressed
34+
35+
plugins:
36+
- jekyll-environment-variables
37+
38+
exclude:
39+
- Gemfile
40+
- Gemfile.lock
41+
- node_modules
42+
- vendor/bundle/
43+
- vendor/cache/
44+
- vendor/gems/
45+
- vendor/ruby/
46+
- LICENSE.md
47+
- LICENSE
48+
- README.md

_data/documentation.yaml

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
overview:
2+
- title: "User Guide"
3+
description: "The guide provides an introduction to the Slang language and its major features, as well as the compilation and reflection API."
4+
link_url: "https://shader-slang.com/slang/user-guide/"
5+
link_label: "User Guide"
6+
- title: "Standard Modules Reference"
7+
description: "The reference of the standard modules that comes with the Slang compiler."
8+
link_url: "https://shader-slang.com/stdlib-reference/"
9+
link_label: "Modules Reference"
10+
- title: "Language Specification"
11+
description: "The formal specification of the Slang programming language. Work in progress.."
12+
link_url: "https://github.com/shader-slang/spec"
13+
link_label: "Language Specification"
14+
- title: "Feature Matureness"
15+
description: "List of Slang Features with their stableness/matureness."
16+
link_url: "https://shader-slang.com/docs/feature_matureness"
17+
link_label: "Feature matureness"
18+
- title: "Command Line Reference"
19+
description: "There is the documentation specific to using the slangc command-line tool."
20+
link_url: "https://github.com/shader-slang/slang/blob/master/docs/command-line-slangc-reference.md"
21+
link_label: "Command Line Reference"
22+
- title: "Frequently Asked Questions"
23+
description: "Answers to a list of frequently asked questions."
24+
link_url: "https://shader-slang.com/docs/faq"
25+
link_label: "Slang FAQ"
26+
27+
articles:
28+
- title: "SPIR-V Specific Functionalities"
29+
description: "Things to know when using Slang to compile to SPIR-V."
30+
link_url: "https://shader-slang.com/slang/user-guide/spirv-target-specific.html"
31+
link_label: "SPIR-V Specifics"
32+
- title: "Metal Specific Functionalities"
33+
description: "Things to know when using Slang to compile to the Metal Shading Language."
34+
link_url: "https://shader-slang.com/slang/user-guide/metal-target-specific"
35+
link_label: "Metal Functionalities"
36+
- title: "WGSL Specific Functionalities"
37+
description: "Things to know when using Slang to compile to the WGSL."
38+
link_url: "https://shader-slang.com/slang/user-guide/wgsl-target-specific"
39+
link_label: "WGSL Functionalities"
40+
41+
tutorials:
42+
- title: "Write Your First Slang Shader"
43+
description: "See how to write a simple compute shader in Slang and compile it for execution on Vulkan."
44+
link_url: "https://shader-slang.com/docs/first-slang-shader"
45+
link_label: "My First Shader"
46+
- title: "Using the Compilation API"
47+
description: "See how to use Slang’s compilation API to integrate the Slang compiler into your application."
48+
link_url: "https://shader-slang.com/slang/user-guide/compiling"
49+
link_label: "The Complitation API"
50+
- title: "Using the Reflection API"
51+
description: "See how to use Slang’s reflection API to query for parameter binding info at runtime."
52+
link_url: "https://shader-slang.com/slang/user-guide/reflection"
53+
link_label: "The Reflection API"
54+
- title: "Understanding Slang Generics"
55+
description: "Learn how to use Slang’s generics and interfaces to write structured code that can be specialized at compile time."
56+
link_url: "/docs/understanding-generics"
57+
link_label: "Slang Generics"
58+
- title: "Migrating from HLSL to Slang"
59+
description: "Main things to know if you are coming to Slang as an HLSL developer."
60+
link_url: "/docs/coming-from-hlsl/"
61+
link_label: "Coming from HLSL"

0 commit comments

Comments
 (0)