Skip to content

Commit 3ef095e

Browse files
filzrevfilzrev
committed
Add docsearch template with default layout
1 parent c47fe4f commit 3ef095e

File tree

2 files changed

+151
-1
lines changed

2 files changed

+151
-1
lines changed

‎docs/docfx.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@
3333
"output": "_site",
3434
"template": [
3535
"default",
36-
"modern"
36+
"modern",
37+
"templates/docsearch"
3738
],
3839
"globalMetadata": {
3940
"_appName": "",

‎docs/templates/docsearch/layout/_master.tmpl

Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
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}}{{^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+
<meta name="docfx:navrel" content="{{_navRel}}">
22+
<meta name="docfx:tocrel" content="{{_tocRel}}">
23+
{{#_noindex}}<meta name="searchOption" content="noindex">{{/_noindex}}
24+
{{#_enableSearch}}<meta name="docfx:rel" content="{{_rel}}">{{/_enableSearch}}
25+
{{#_disableNewTab}}<meta name="docfx:disablenewtab" content="true">{{/_disableNewTab}}
26+
{{#_disableTocFilter}}<meta name="docfx:disabletocfilter" content="true">{{/_disableTocFilter}}
27+
{{#docurl}}<meta name="docfx:docurl" content="{{docurl}}">{{/docurl}}
28+
<meta name="loc:inThisArticle" content="{{__global.inThisArticle}}">
29+
<meta name="loc:searchResultsCount" content="{{__global.searchResultsCount}}">
30+
<meta name="loc:searchNoResults" content="{{__global.searchNoResults}}">
31+
<meta name="loc:tocFilter" content="{{__global.tocFilter}}">
32+
<meta name="loc:nextArticle" content="{{__global.nextArticle}}">
33+
<meta name="loc:prevArticle" content="{{__global.prevArticle}}">
34+
<meta name="loc:themeLight" content="{{__global.themeLight}}">
35+
<meta name="loc:themeDark" content="{{__global.themeDark}}">
36+
<meta name="loc:themeAuto" content="{{__global.themeAuto}}">
37+
<meta name="loc:changeTheme" content="{{__global.changeTheme}}">
38+
<meta name="loc:copy" content="{{__global.copy}}">
39+
<meta name="loc:downloadPdf" content="{{__global.downloadPdf}}">
40+
{{/redirect_url}}
41+
</head>
42+
43+
{{^redirect_url}}
44+
<script type="module" src="./{{_rel}}public/docfx.min.js"></script>
45+
46+
<script>
47+
const theme = localStorage.getItem('theme') || 'auto'
48+
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
49+
</script>
50+
51+
{{#_googleAnalyticsTagId}}
52+
<script async src="https://www.googletagmanager.com/gtag/js?id={{_googleAnalyticsTagId}}"></script>
53+
<script>
54+
window.dataLayer = window.dataLayer || [];
55+
function gtag() { dataLayer.push(arguments); }
56+
gtag('js', new Date());
57+
gtag('config', '{{_googleAnalyticsTagId}}');
58+
</script>
59+
{{/_googleAnalyticsTagId}}
60+
61+
<body class="tex2jax_ignore" data-layout="{{_layout}}{{layout}}" data-yaml-mime="{{yamlmime}}">
62+
<header class="bg-body border-bottom">
63+
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
64+
<div class="container-xxl flex-nowrap">
65+
<a class="navbar-brand" href="{{_appLogoUrl}}{{^_appLogoUrl}}{{_rel}}index.html{{/_appLogoUrl}}">
66+
<img id="logo" class="svg" src="{{_rel}}{{{_appLogoPath}}}{{^_appLogoPath}}logo.svg{{/_appLogoPath}}" alt="{{_appName}}" >
67+
{{_appName}}
68+
</a>
69+
<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">
70+
<i class="bi bi-three-dots"></i>
71+
</button>
72+
<div class="collapse navbar-collapse" id="navpanel">
73+
<div id="navbar">
74+
{{#_enableSearch}}
75+
<form class="search" role="search" id="search">
76+
<i class="bi bi-search"></i>
77+
<input class="form-control" id="search-query" type="search" disabled placeholder="{{__global.search}}" autocomplete="off" aria-label="Search">
78+
</form>
79+
{{/_enableSearch}}
80+
</div>
81+
</div>
82+
</div>
83+
</nav>
84+
</header>
85+
86+
<main class="container-xxl">
87+
<div class="toc-offcanvas">
88+
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
89+
<div class="offcanvas-header">
90+
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
91+
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
92+
</div>
93+
<div class="offcanvas-body">
94+
<nav class="toc" id="toc"></nav>
95+
</div>
96+
</div>
97+
</div>
98+
99+
<div class="content">
100+
<div class="actionbar">
101+
<button class="btn btn-lg border-0 d-md-none" style="margin-top: -.65em; margin-left: -.8em"
102+
type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas"
103+
aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
104+
<i class="bi bi-list"></i>
105+
</button>
106+
107+
<nav id="breadcrumb"></nav>
108+
</div>
109+
110+
<article data-uid="{{uid}}">
111+
{{!body}}
112+
</article>
113+
114+
{{^_disableContribution}}
115+
<div class="contribution d-print-none">
116+
{{#sourceurl}}
117+
<a href="{{sourceurl}}" class="edit-link">{{__global.improveThisDoc}}</a>
118+
{{/sourceurl}}
119+
{{^sourceurl}}{{#docurl}}
120+
<a href="{{docurl}}" class="edit-link">{{__global.improveThisDoc}}</a>
121+
{{/docurl}}{{/sourceurl}}
122+
</div>
123+
{{/_disableContribution}}
124+
125+
{{^_disableNextArticle}}
126+
<div class="next-article d-print-none border-top" id="nextArticle"></div>
127+
{{/_disableNextArticle}}
128+
129+
</div>
130+
131+
<div class="affix">
132+
<nav id="affix"></nav>
133+
</div>
134+
</main>
135+
136+
{{#_enableSearch}}
137+
<div class="container-xxl search-results" id="search-results"></div>
138+
{{/_enableSearch}}
139+
140+
<footer class="border-top text-secondary">
141+
<div class="container-xxl">
142+
<div class="flex-fill">
143+
{{{_appFooter}}}{{^_appFooter}}<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>{{/_appFooter}}
144+
</div>
145+
</div>
146+
</footer>
147+
</body>
148+
{{/redirect_url}}
149+
</html>

0 commit comments

Comments
 (0)