Skip to content

Commit dc571f1

Browse files
authored
Update gfx getting started doc (shader-slang#1832)
1 parent a342080 commit dc571f1

9 files changed

+306
-219
lines changed

docs/_layouts/user-guide.html

+3-2
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,6 @@
5252
position: fixed;
5353
overflow-y: auto;
5454
box-sizing: border-box;
55-
max-height: 100vh;
5655
display: block;
5756
}
5857

@@ -100,7 +99,7 @@
10099
}
101100
.toc_span:hover
102101
{
103-
color: #3030BE
102+
color: #d5000d;
104103
}
105104
.tocIcon
106105
{
@@ -138,6 +137,7 @@
138137
#tocColumn {
139138
width: 300px;
140139
display: block;
140+
box-sizing: border-box;
141141
}
142142
#rightColumn {
143143
padding-left: 320px;
@@ -151,6 +151,7 @@
151151
position: static;
152152
display: none;
153153
border-right-style: none;
154+
box-sizing: content-box;
154155
}
155156
#tocInner {
156157
padding: 10px;

docs/assets/css/style.scss

+171-1
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,174 @@ body {
3030
#container
3131
{
3232
background:none;
33-
}
33+
}
34+
35+
36+
37+
.highlight .cm {
38+
color: #148b04;
39+
}
40+
.highlight .cp {
41+
color: #148b04;
42+
}
43+
.highlight .c1 {
44+
color: #148b04;
45+
}
46+
.highlight .cs {
47+
color: #148b04;
48+
}
49+
.highlight .c, .highlight .ch, .highlight .cd, .highlight .cpf {
50+
color: #148b04;
51+
}
52+
.highlight .err {
53+
color: #a61717;
54+
background-color: #e3d2d2;
55+
}
56+
.highlight .gd {
57+
color: #000000;
58+
background-color: #ffdddd;
59+
}
60+
.highlight .ge {
61+
color: #000000;
62+
font-style: italic;
63+
}
64+
.highlight .gr {
65+
color: #aa0000;
66+
}
67+
.highlight .gh {
68+
color: #999999;
69+
}
70+
.highlight .gi {
71+
color: #000000;
72+
background-color: #ddffdd;
73+
}
74+
.highlight .go {
75+
color: #888888;
76+
}
77+
.highlight .gp {
78+
color: #555555;
79+
}
80+
.highlight .gu {
81+
color: #aaaaaa;
82+
}
83+
.highlight .gt {
84+
color: #aa0000;
85+
}
86+
.highlight .kc {
87+
color: #1243d4;
88+
}
89+
.highlight .kd {
90+
color: #1243d4;
91+
}
92+
.highlight .kn {
93+
color: #1243d4;
94+
}
95+
.highlight .kp {
96+
color: #1243d4;
97+
}
98+
.highlight .kr {
99+
color: #1243d4;
100+
}
101+
.highlight .kt {
102+
color: #1243d4;
103+
}
104+
.highlight .k, .highlight .kv {
105+
color: #1243d4;
106+
}
107+
.highlight .m, .highlight .mb, .highlight .mx, .highlight .mi, .highlight .mf {
108+
color: #7211c2;
109+
}
110+
.highlight .sa {
111+
color: #000000;
112+
}
113+
.highlight .sb {
114+
color: #d14;
115+
}
116+
.highlight .sc {
117+
color: #d14;
118+
}
119+
.highlight .sd {
120+
color: #d14;
121+
}
122+
.highlight .s2 {
123+
color: #d14;
124+
}
125+
.highlight .se {
126+
color: #d14;
127+
}
128+
.highlight .sh {
129+
color: #d14;
130+
}
131+
.highlight .si {
132+
color: #d14;
133+
}
134+
.highlight .sx {
135+
color: #d14;
136+
}
137+
.highlight .sr {
138+
color: #009926;
139+
}
140+
.highlight .s1 {
141+
color: #d14;
142+
}
143+
.highlight .ss {
144+
color: #990073;
145+
}
146+
.highlight .s, .highlight .dl {
147+
color: #d14;
148+
}
149+
.highlight .na {
150+
color: #008080;
151+
}
152+
.highlight .bp {
153+
color: #999999;
154+
}
155+
.highlight .n{
156+
color: black;
157+
}
158+
.highlight .nc {
159+
color: #11abb9;
160+
}
161+
.highlight .nt {
162+
color: #11abb9;
163+
}
164+
.highlight .vc {
165+
color: #008080;
166+
}
167+
.highlight .vg {
168+
color: #008080;
169+
}
170+
.highlight .vi {
171+
color: #008080;
172+
}
173+
.highlight .nv, .highlight .vm {
174+
color: #008080;
175+
}
176+
.highlight .ow {
177+
color: #000000;
178+
}
179+
.highlight .o {
180+
color: #000000;
181+
}
182+
.highlight .w {
183+
color: #000000;
184+
}
185+
.highlight .p {color:#000000;}
186+
187+
code
188+
{
189+
background-color: initial;
190+
border:none;
191+
}
192+
pre{
193+
color: #000000;
194+
background: #F8F8F8;
195+
}
196+
pre code {
197+
color: #000000;
198+
background-color: #F8F8F8;
199+
}
200+
.highlight
201+
{
202+
background: #F8F8F8;
203+
}

docs/build_toc.ps1

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
$job = Start-Job -ArgumentList $PSScriptRoot -ScriptBlock {
2+
Set-Location $args[0]
3+
$code = (Get-Content -Raw -Path "scripts/Program.cs").ToString()
4+
$assemblies = ("System.Core", "System.IO", "System.Collections")
5+
Add-Type -ReferencedAssemblies $assemblies -TypeDefinition $code -Language CSharp
6+
$path = Join-Path -Path $args[0] -ChildPath "user-guide"
7+
[toc.Builder]::Run($path);
8+
$path = Join-Path -Path $args[0] -ChildPath "gfx-user-guide"
9+
[toc.Builder]::Run($path);
10+
}
11+
Wait-Job $job
12+
Receive-Job -Job $job

0 commit comments

Comments
 (0)