Skip to content

Commit f890e16

Browse files
bradwilsonbradwilson
committed
Home pages for each version with commonly used types
1 parent a9f0fb6 commit f890e16

File tree

11 files changed

+910
-19
lines changed

11 files changed

+910
-19
lines changed

‎site/docfx.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
{
22
"build": {
3+
"markdownEngineProperties": {
4+
"markdigExtensions": [
5+
"attributes",
6+
"customcontainers",
7+
"emphasisextras",
8+
"gridtables"
9+
]
10+
},
311
"content": [
412
{
513
"files": "**/*.yml",
@@ -29,6 +37,10 @@
2937
"_appTitle": "xUnit.net",
3038
"_appFooter": "Copyright &copy; <a href=\"https://dotnetfoundation.org/\">.NET Foundation</a> and Contributors. Content licensed under <a href=\"https://github.com/xunit/api.xunit.net/blob/main/LICENSE\">Apache 2</a>.",
3139
"_appFaviconPath": "images/logo-128-transparent.png",
40+
"_disableBreadcrumb": true,
41+
"_disableNextArticle": true,
42+
"_disableToc": false,
43+
"_enableNewTab": true,
3244
"_enableSearch": true,
3345
"pdf": false
3446
},

‎site/templates/xunit/layout/_master.tmpl‎

Lines changed: 180 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,180 @@
1+
{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}
2+
{{!include(/^public/.*/)}}
3+
{{!include(favicon.ico)}}
4+
{{!include(logo.svg)}}
5+
<!DOCTYPE html>
6+
<html {{#_lang}}lang="{{_lang}}"{{/_lang}}>
7+
<head>
8+
<meta charset="utf-8">
9+
{{#redirect_url}}
10+
<meta http-equiv="refresh" content="0;URL='{{redirect_url}}'">
11+
{{/redirect_url}}
12+
{{^redirect_url}}
13+
<title>{{#title}}{{title}}{{#title-version}} [{{title-version}}]{{/title-version}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}}</title>
14+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
15+
<meta name="title" content="{{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}}">
16+
{{#_description}}<meta name="description" content="{{_description}}">{{/_description}}
17+
{{#description}}<meta name="description" content="{{description}}">{{/description}}
18+
<link rel="icon" href="{{_rel}}{{{_appFaviconPath}}}{{^_appFaviconPath}}favicon.ico{{/_appFaviconPath}}">
19+
<link rel="stylesheet" href="{{_rel}}public/docfx.min.css">
20+
<link rel="stylesheet" href="{{_rel}}public/main.css">
21+
{{#css}}<link rel="stylesheet" href="{{_rel}}public/{{css}}">{{/css}}
22+
<meta name="docfx:navrel" content="{{_navRel}}">
23+
<meta name="docfx:tocrel" content="{{_tocRel}}">
24+
{{#_noindex}}<meta name="searchOption" content="noindex">{{/_noindex}}
25+
{{#_enableSearch}}<meta name="docfx:rel" content="{{_rel}}">{{/_enableSearch}}
26+
{{#_disableNewTab}}<meta name="docfx:disablenewtab" content="true">{{/_disableNewTab}}
27+
{{#_disableTocFilter}}<meta name="docfx:disabletocfilter" content="true">{{/_disableTocFilter}}
28+
{{#docurl}}<meta name="docfx:docurl" content="{{docurl}}">{{/docurl}}
29+
<meta name="loc:inThisArticle" content="{{__global.inThisArticle}}">
30+
<meta name="loc:searchResultsCount" content="{{__global.searchResultsCount}}">
31+
<meta name="loc:searchNoResults" content="{{__global.searchNoResults}}">
32+
<meta name="loc:tocFilter" content="{{__global.tocFilter}}">
33+
<meta name="loc:nextArticle" content="{{__global.nextArticle}}">
34+
<meta name="loc:prevArticle" content="{{__global.prevArticle}}">
35+
<meta name="loc:themeLight" content="{{__global.themeLight}}">
36+
<meta name="loc:themeDark" content="{{__global.themeDark}}">
37+
<meta name="loc:themeAuto" content="{{__global.themeAuto}}">
38+
<meta name="loc:changeTheme" content="{{__global.changeTheme}}">
39+
<meta name="loc:copy" content="{{__global.copy}}">
40+
<meta name="loc:downloadPdf" content="{{__global.downloadPdf}}">
41+
42+
<script type="module" src="./{{_rel}}public/docfx.min.js"></script>
43+
44+
<script>
45+
const theme = localStorage.getItem('theme') || 'auto'
46+
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
47+
</script>
48+
49+
{{#_googleAnalyticsTagId}}
50+
<script async src="https://www.googletagmanager.com/gtag/js?id={{_googleAnalyticsTagId}}"></script>
51+
<script>
52+
window.dataLayer = window.dataLayer || [];
53+
function gtag() { dataLayer.push(arguments); }
54+
gtag('js', new Date());
55+
gtag('config', '{{_googleAnalyticsTagId}}');
56+
</script>
57+
{{/_googleAnalyticsTagId}}
58+
{{/redirect_url}}
59+
</head>
60+
61+
{{^redirect_url}}
62+
<body class="tex2jax_ignore" data-layout="{{_layout}}{{layout}}" data-yaml-mime="{{yamlmime}}">
63+
<header class="bg-body border-bottom">
64+
{{^_disableNavbar}}
65+
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
66+
<div class="container-xxl flex-nowrap">
67+
<a class="navbar-brand" href="{{_appLogoUrl}}{{^_appLogoUrl}}{{_rel}}index.html{{/_appLogoUrl}}">
68+
<img id="logo" class="svg" src="{{_rel}}{{{_appLogoPath}}}{{^_appLogoPath}}logo.svg{{/_appLogoPath}}" alt="{{_appName}}" >
69+
{{_appName}}
70+
</a>
71+
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
72+
<i class="bi bi-three-dots"></i>
73+
</button>
74+
<div class="collapse navbar-collapse" id="navpanel">
75+
<div id="navbar">
76+
{{#_enableSearch}}
77+
<form class="search" role="search" id="search">
78+
<i class="bi bi-search"></i>
79+
<input class="form-control" id="search-query" type="search" disabled placeholder="{{__global.search}}" autocomplete="off" aria-label="Search">
80+
</form>
81+
{{/_enableSearch}}
82+
</div>
83+
</div>
84+
</div>
85+
</nav>
86+
{{/_disableNavbar}}
87+
</header>
88+
89+
<main class="container-xxl">
90+
{{^_disableToc}}
91+
<div class="toc-offcanvas">
92+
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
93+
<div class="offcanvas-header">
94+
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
95+
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
96+
</div>
97+
<div class="offcanvas-body">
98+
<nav class="toc" id="toc"></nav>
99+
</div>
100+
</div>
101+
</div>
102+
{{/_disableToc}}
103+
104+
<div class="content">
105+
<div class="actionbar">
106+
{{^_disableToc}}
107+
<button class="btn btn-lg border-0 d-md-none"
108+
type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas"
109+
aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
110+
<i class="bi bi-list"></i>
111+
</button>
112+
{{/_disableToc}}
113+
114+
{{^_disableBreadcrumb}}
115+
<nav id="breadcrumb"></nav>
116+
{{/_disableBreadcrumb}}
117+
</div>
118+
119+
<article data-uid="{{uid}}">
120+
{{#title-version}}
121+
<h1>{{title}} <span class="label label-title-version">{{ title-version }}</span></h1>
122+
{{#logo-title}}<p><img src="https://raw.githubusercontent.com/xunit/media/main/dotnet-foundation.svg" class="dnflogo" title=".NET Foundation logo" /></p>{{/logo-title}}
123+
{{/title-version}}
124+
125+
{{#analyzer}}
126+
<div>
127+
<div style="font-size: 150%; float: right;">
128+
&nbsp;
129+
<span class="label label-version-{{ v2 }}">v2</span>
130+
<span class="label label-version-{{ v3 }}">v3</span>
131+
&nbsp;
132+
<span class="label label-{{ severity }}">{{ severity }}</span>
133+
</div>
134+
<h1>{{ title }}</h1>
135+
</div>
136+
137+
<p><em>&quot;{{description}}&quot;</em><p>
138+
{{/analyzer}}
139+
140+
{{!body}}
141+
</article>
142+
143+
{{^_disableContribution}}
144+
<div class="contribution d-print-none">
145+
{{#sourceurl}}
146+
<a href="{{sourceurl}}" class="edit-link">{{__global.improveThisDoc}}</a>
147+
{{/sourceurl}}
148+
{{^sourceurl}}{{#docurl}}
149+
<a href="{{docurl}}" class="edit-link">{{__global.improveThisDoc}}</a>
150+
{{/docurl}}{{/sourceurl}}
151+
</div>
152+
{{/_disableContribution}}
153+
154+
{{^_disableNextArticle}}
155+
<div class="next-article d-print-none border-top" id="nextArticle"></div>
156+
{{/_disableNextArticle}}
157+
158+
</div>
159+
160+
{{^_disableAffix}}
161+
<div class="affix">
162+
<nav id="affix"></nav>
163+
</div>
164+
{{/_disableAffix}}
165+
</main>
166+
167+
{{#_enableSearch}}
168+
<div class="container-xxl search-results" id="search-results"></div>
169+
{{/_enableSearch}}
170+
171+
<footer class="border-top text-secondary">
172+
<div class="container-xxl">
173+
<div class="flex-fill">
174+
{{{_appFooter}}}{{^_appFooter}}<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>{{/_appFooter}}
175+
</div>
176+
</div>
177+
</footer>
178+
</body>
179+
{{/redirect_url}}
180+
</html>

0 commit comments

Comments
 (0)