Skip to content

Commit a204478

Browse files
natakazakovaDXInfinitypollyndos
authored
Move to new docfx 24.1 (#217)
* update to new doc fx * Update README.md * fix matomo updated partial for 'default', added layout for modern, fix parameters to pass metadata * Apply suggestions from code review Co-authored-by: pollyndos <[email protected]> * add gitignore * add license * fix word order * move note --------- Co-authored-by: Sergey Avramenko <[email protected]> Co-authored-by: pollyndos <[email protected]>
1 parent 1c17ead commit a204478

File tree

23 files changed

+428
-160
lines changed

23 files changed

+428
-160
lines changed

‎.github/workflows/build-eud-on-pull-request.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,4 @@ jobs:
2020
run: Expand-Archive ../docfx-win-x64-v2.77.0.zip -DestinationPath ../docfx
2121

2222
- name: Build site with docfx
23-
run: ../docfx/docfx.exe build docfx.json --warningsAsErrors
23+
run: ../docfx/docfx.exe build docfx.json -m _matomoContainerUrl="https://matomo.devexpress.com/js/container_kE7MWPi0.js" --warningsAsErrors

‎.github/workflows/update-gh-pages-branch.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ jobs:
2020
run: Expand-Archive ../docfx-win-x64-v2.77.0.zip -DestinationPath ../docfx
2121

2222
- name: Build site with docfx
23-
run: "../docfx/docfx.exe build docfx.json --metadata \"{ '_matomoContainerUrl': 'https://matomo.devexpress.com/js/container_kE7MWPi0.js' }\" --warningsAsErrors"
23+
run: "../docfx/docfx.exe build docfx.json -m _matomoContainerUrl=\"https://matomo.devexpress.com/js/container_kE7MWPi0.js\" --warningsAsErrors"
2424

2525
- name: Archive site
2626
run: Compress-Archive -Path _site/* -DestinationPath ${{ runner.temp }}/site.zip
@@ -54,4 +54,4 @@ jobs:
5454
git config user.email [email protected]
5555
git add .
5656
git commit -m "Pages update"
57-
git push
57+
git push

‎.gitignore‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
1-
_*
2-
obj
3-
.vscode
1+
_site
2+
*.pdf

‎.template/layout/_master.tmpl‎

Lines changed: 169 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,169 @@
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+
41+
<script type="module" src="./{{_rel}}public/docfx.min.js"></script>
42+
43+
<script>
44+
const theme = localStorage.getItem('theme') || 'auto'
45+
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
46+
</script>
47+
48+
{{#_googleAnalyticsTagId}}
49+
<script async src="https://www.googletagmanager.com/gtag/js?id={{_googleAnalyticsTagId}}"></script>
50+
<script>
51+
window.dataLayer = window.dataLayer || [];
52+
function gtag() { dataLayer.push(arguments); }
53+
gtag('js', new Date());
54+
gtag('config', '{{_googleAnalyticsTagId}}');
55+
</script>
56+
{{/_googleAnalyticsTagId}}
57+
{{#_matomoContainerUrl}}
58+
<!-- Matomo Tag Manager -->
59+
<script>
60+
var _mtm = window._mtm = window._mtm || [];
61+
_mtm.push({'mtm.startTime': (new Date().getTime()), 'event': 'mtm.Start'});
62+
var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
63+
g.async=true; g.src='{{_matomoContainerUrl}}'; s.parentNode.insertBefore(g,s);
64+
</script>
65+
<!-- End Matomo Tag Manager -->
66+
{{/_matomoContainerUrl}}
67+
{{/redirect_url}}
68+
</head>
69+
70+
{{^redirect_url}}
71+
<body class="tex2jax_ignore" data-layout="{{_layout}}{{layout}}" data-yaml-mime="{{yamlmime}}">
72+
<header class="bg-body border-bottom">
73+
{{^_disableNavbar}}
74+
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
75+
<div class="container-xxl flex-nowrap">
76+
<a class="navbar-brand" href="{{_appLogoUrl}}{{^_appLogoUrl}}{{_rel}}index.html{{/_appLogoUrl}}">
77+
<img id="logo" class="svg" src="{{_rel}}{{{_appLogoPath}}}{{^_appLogoPath}}logo.svg{{/_appLogoPath}}" alt="{{_appName}}" >
78+
{{_appName}}
79+
</a>
80+
<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">
81+
<i class="bi bi-three-dots"></i>
82+
</button>
83+
<div class="collapse navbar-collapse" id="navpanel">
84+
<div id="navbar">
85+
{{#_enableSearch}}
86+
<form class="search" role="search" id="search">
87+
<i class="bi bi-search"></i>
88+
<input class="form-control" id="search-query" type="search" disabled placeholder="{{__global.search}}" autocomplete="off" aria-label="Search">
89+
</form>
90+
{{/_enableSearch}}
91+
</div>
92+
</div>
93+
</div>
94+
</nav>
95+
{{/_disableNavbar}}
96+
</header>
97+
98+
<main class="container-xxl">
99+
{{^_disableToc}}
100+
<div class="toc-offcanvas">
101+
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
102+
<div class="offcanvas-header">
103+
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
104+
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
105+
</div>
106+
<div class="offcanvas-body">
107+
<nav class="toc" id="toc"></nav>
108+
</div>
109+
</div>
110+
</div>
111+
{{/_disableToc}}
112+
113+
<div class="content">
114+
<div class="actionbar">
115+
{{^_disableToc}}
116+
<button class="btn btn-lg border-0 d-md-none"
117+
type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas"
118+
aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
119+
<i class="bi bi-list"></i>
120+
</button>
121+
{{/_disableToc}}
122+
123+
{{^_disableBreadcrumb}}
124+
<nav id="breadcrumb"></nav>
125+
{{/_disableBreadcrumb}}
126+
</div>
127+
128+
<article data-uid="{{uid}}">
129+
{{!body}}
130+
</article>
131+
132+
{{^_disableContribution}}
133+
<div class="contribution d-print-none">
134+
{{#sourceurl}}
135+
<a href="{{sourceurl}}" class="edit-link">{{__global.improveThisDoc}}</a>
136+
{{/sourceurl}}
137+
{{^sourceurl}}{{#docurl}}
138+
<a href="{{docurl}}" class="edit-link">{{__global.improveThisDoc}}</a>
139+
{{/docurl}}{{/sourceurl}}
140+
</div>
141+
{{/_disableContribution}}
142+
143+
{{^_disableNextArticle}}
144+
<div class="next-article d-print-none border-top" id="nextArticle"></div>
145+
{{/_disableNextArticle}}
146+
147+
</div>
148+
149+
{{^_disableAffix}}
150+
<div class="affix">
151+
<nav id="affix"></nav>
152+
</div>
153+
{{/_disableAffix}}
154+
</main>
155+
156+
{{#_enableSearch}}
157+
<div class="container-xxl search-results" id="search-results"></div>
158+
{{/_enableSearch}}
159+
160+
<footer class="border-top text-secondary">
161+
<div class="container-xxl">
162+
<div class="flex-fill">
163+
{{{_appFooter}}}{{^_appFooter}}<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>{{/_appFooter}}
164+
</div>
165+
</div>
166+
</footer>
167+
</body>
168+
{{/redirect_url}}
169+
</html>

‎.template/partials/head.tmpl.partial‎

Lines changed: 38 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,44 @@
1-
{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}}
1+
{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}
22

33
<head>
44
<meta charset="utf-8">
5-
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
6-
<title>{{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}}</title>
7-
<meta name="viewport" content="width=device-width">
8-
<meta name="title" content="{{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}}">
9-
<meta name="generator" content="docfx {{_docfxVersion}}">
10-
{{#_description}}<meta name="description" content="{{_description}}">{{/_description}}
11-
<link rel="shortcut icon" href="{{_rel}}{{{_appFaviconPath}}}{{^_appFaviconPath}}favicon.ico{{/_appFaviconPath}}">
12-
<link rel="stylesheet" href="{{_rel}}styles/docfx.vendor.min.css">
13-
<link rel="stylesheet" href="{{_rel}}styles/docfx.css">
14-
<link rel="stylesheet" href="{{_rel}}styles/main.css">
15-
<meta property="docfx:navrel" content="{{_navRel}}">
16-
<meta property="docfx:tocrel" content="{{_tocRel}}">
17-
{{#_noindex}}<meta name="searchOption" content="noindex">{{/_noindex}}
18-
{{#_enableSearch}}<meta property="docfx:rel" content="{{_rel}}">{{/_enableSearch}}
19-
{{#_enableNewTab}}<meta property="docfx:newtab" content="true">{{/_enableNewTab}}
20-
{{#_matomoContainerUrl}}
21-
<!-- Matomo Tag Manager -->
5+
{{#_googleAnalyticsTagId}}
6+
<script async src="https://www.googletagmanager.com/gtag/js?id={{_googleAnalyticsTagId}}"></script>
227
<script>
23-
var _mtm = window._mtm = window._mtm || [];
24-
_mtm.push({'mtm.startTime': (new Date().getTime()), 'event': 'mtm.Start'});
25-
var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
26-
g.async=true; g.src='{{_matomoContainerUrl}}'; s.parentNode.insertBefore(g,s);
8+
window.dataLayer = window.dataLayer || [];
9+
function gtag() { dataLayer.push(arguments); }
10+
gtag('js', new Date());
11+
gtag('config', '{{_googleAnalyticsTagId}}');
2712
</script>
28-
<!-- End Matomo Tag Manager -->
29-
{{/_matomoContainerUrl}}
13+
{{/_googleAnalyticsTagId}}
14+
{{#redirect_url}}
15+
<meta http-equiv="refresh" content="0;URL='{{redirect_url}}'">
16+
{{/redirect_url}}
17+
{{^redirect_url}}
18+
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
19+
<title>{{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}}</title>
20+
<meta name="viewport" content="width=device-width">
21+
<meta name="title" content="{{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}}">
22+
{{#_description}}<meta name="description" content="{{_description}}">{{/_description}}
23+
{{#description}}<meta name="description" content="{{description}}">{{/description}}
24+
<link rel="shortcut icon" href="{{_rel}}{{{_appFaviconPath}}}{{^_appFaviconPath}}favicon.ico{{/_appFaviconPath}}">
25+
<link rel="stylesheet" href="{{_rel}}styles/docfx.vendor.min.css">
26+
<link rel="stylesheet" href="{{_rel}}styles/docfx.css">
27+
<link rel="stylesheet" href="{{_rel}}styles/main.css">
28+
<meta property="docfx:navrel" content="{{_navRel}}">
29+
<meta property="docfx:tocrel" content="{{_tocRel}}">
30+
{{#_noindex}}<meta name="searchOption" content="noindex">{{/_noindex}}
31+
{{#_enableSearch}}<meta property="docfx:rel" content="{{_rel}}">{{/_enableSearch}}
32+
{{#_enableNewTab}}<meta property="docfx:newtab" content="true">{{/_enableNewTab}}
33+
{{#_matomoContainerUrl}}
34+
<!-- Matomo Tag Manager -->
35+
<script>
36+
var _mtm = window._mtm = window._mtm || [];
37+
_mtm.push({'mtm.startTime': (new Date().getTime()), 'event': 'mtm.Start'});
38+
var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
39+
g.async=true; g.src='{{_matomoContainerUrl}}'; s.parentNode.insertBefore(g,s);
40+
</script>
41+
<!-- End Matomo Tag Manager -->
42+
{{/_matomoContainerUrl}}
43+
{{/redirect_url}}
3044
</head>

‎.template/public/main.css‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
/* file: my-template/public/main.css */
2+
article a {
3+
text-decoration: none;
4+
}
5+
article a:hover{
6+
text-decoration: underline;
7+
}

‎.template/public/main.js‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
/* file: .template/public/main.js */
2+
export default {
3+
defaultTheme: 'dark',
4+
iconLinks: [
5+
{
6+
icon: 'github',
7+
href: 'https://github.com/DevExpress/dotnet-eud',
8+
title: 'GitHub'
9+
}
10+
]
11+
}

0 commit comments

Comments
 (0)