diff --git a/.github/workflows/build-eud-on-pull-request.yml b/.github/workflows/build-eud-on-pull-request.yml index 6597c73d9..c1ca14624 100644 --- a/.github/workflows/build-eud-on-pull-request.yml +++ b/.github/workflows/build-eud-on-pull-request.yml @@ -20,4 +20,4 @@ jobs: run: Expand-Archive ../docfx-win-x64-v2.77.0.zip -DestinationPath ../docfx - name: Build site with docfx - run: ../docfx/docfx.exe build docfx.json --warningsAsErrors \ No newline at end of file + run: ../docfx/docfx.exe build docfx.json -m _matomoContainerUrl="https://matomo.devexpress.com/js/container_kE7MWPi0.js" --warningsAsErrors \ No newline at end of file diff --git a/.github/workflows/update-gh-pages-branch.yml b/.github/workflows/update-gh-pages-branch.yml index 95b69099a..1fb9c55a7 100644 --- a/.github/workflows/update-gh-pages-branch.yml +++ b/.github/workflows/update-gh-pages-branch.yml @@ -20,7 +20,7 @@ jobs: run: Expand-Archive ../docfx-win-x64-v2.77.0.zip -DestinationPath ../docfx - name: Build site with docfx - run: "../docfx/docfx.exe build docfx.json --metadata \"{ '_matomoContainerUrl': 'https://matomo.devexpress.com/js/container_kE7MWPi0.js' }\" --warningsAsErrors" + run: "../docfx/docfx.exe build docfx.json -m _matomoContainerUrl=\"https://matomo.devexpress.com/js/container_kE7MWPi0.js\" --warningsAsErrors" - name: Archive site run: Compress-Archive -Path _site/* -DestinationPath ${{ runner.temp }}/site.zip diff --git a/.template/layout/_master.tmpl b/.template/layout/_master.tmpl new file mode 100644 index 000000000..bb20e4417 --- /dev/null +++ b/.template/layout/_master.tmpl @@ -0,0 +1,169 @@ +{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}} +{{!include(/^public/.*/)}} +{{!include(favicon.ico)}} +{{!include(logo.svg)}} + + + + + {{#redirect_url}} + + {{/redirect_url}} + {{^redirect_url}} + {{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}} + + + {{#_description}}{{/_description}} + {{#description}}{{/description}} + + + + + + {{#_noindex}}{{/_noindex}} + {{#_enableSearch}}{{/_enableSearch}} + {{#_disableNewTab}}{{/_disableNewTab}} + {{#_disableTocFilter}}{{/_disableTocFilter}} + {{#docurl}}{{/docurl}} + + + + + + + + + + + + + + + + + + {{#_googleAnalyticsTagId}} + + + {{/_googleAnalyticsTagId}} + {{#_matomoContainerUrl}} + + + + {{/_matomoContainerUrl}} + {{/redirect_url}} + + + {{^redirect_url}} + +
+ {{^_disableNavbar}} + + {{/_disableNavbar}} +
+ +
+ {{^_disableToc}} +
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ {{/_disableToc}} + +
+
+ {{^_disableToc}} + + {{/_disableToc}} + + {{^_disableBreadcrumb}} + + {{/_disableBreadcrumb}} +
+ +
+ {{!body}} +
+ + {{^_disableContribution}} +
+ {{#sourceurl}} + {{__global.improveThisDoc}} + {{/sourceurl}} + {{^sourceurl}}{{#docurl}} + {{__global.improveThisDoc}} + {{/docurl}}{{/sourceurl}} +
+ {{/_disableContribution}} + + {{^_disableNextArticle}} + + {{/_disableNextArticle}} + +
+ + {{^_disableAffix}} +
+ +
+ {{/_disableAffix}} +
+ + {{#_enableSearch}} +
+ {{/_enableSearch}} + + + + {{/redirect_url}} + diff --git a/.template/partials/head.tmpl.partial b/.template/partials/head.tmpl.partial index 32fd1648e..40a2f7fc3 100644 --- a/.template/partials/head.tmpl.partial +++ b/.template/partials/head.tmpl.partial @@ -1,30 +1,44 @@ -{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} +{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}} - - {{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}} - - - - {{#_description}}{{/_description}} - - - - - - - {{#_noindex}}{{/_noindex}} - {{#_enableSearch}}{{/_enableSearch}} - {{#_enableNewTab}}{{/_enableNewTab}} - {{#_matomoContainerUrl}} - + {{#_googleAnalyticsTagId}} + - - {{/_matomoContainerUrl}} - \ No newline at end of file + {{/_googleAnalyticsTagId}} + {{#redirect_url}} + + {{/redirect_url}} + {{^redirect_url}} + + {{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}} + + + {{#_description}}{{/_description}} + {{#description}}{{/description}} + + + + + + + {{#_noindex}}{{/_noindex}} + {{#_enableSearch}}{{/_enableSearch}} + {{#_enableNewTab}}{{/_enableNewTab}} + {{#_matomoContainerUrl}} + + + + {{/_matomoContainerUrl}} + {{/redirect_url}} + diff --git a/README.md b/README.md index cb1788c67..58ec05776 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ If you search for **Developer Documentation with API Reference**, refer to [docs ## Document Format and Supported Output Types Documents in this repository are written in markdown. You can manually copy the information to your own help file according to our [license](LICENSE.md). -The repository uses [DocFX](https://dotnet.github.io/docfx/) to convert these files from a set of markdown topics to an HTML website or a PDF file. +The repository uses [DocFX](https://dotnet.github.io/docfx/) to convert markdown files to an HTML website or a PDF file. You can make the following changes to the documentation, or skip this step if you want to reuse the end-user documentation as is: @@ -26,7 +26,7 @@ You can make the following changes to the documentation, or skip this step if yo Do one of the following to view the End-User Documentation content: 1. Browse this repository's content directly: [index.md](index.md) -1. View the sample pre-built website: [devexpress.github.io/dotnet-eud](https://devexpress.github.io/dotnet-eud/) +1. View the pre-built sample website: [devexpress.github.io/dotnet-eud](https://devexpress.github.io/dotnet-eud/) 1. [Build an HTML Website](#build-an-html-website) 1. [Build PDF files](#build-pdf-files) @@ -34,7 +34,7 @@ Do one of the following to view the End-User Documentation content: > Prerequisites > - Familiarity with the command line -> - Install [.NET SDK](https://dotnet.microsoft.com/en-us/download) 6.0 or higher +> - [.NET SDK](https://dotnet.microsoft.com/en-us/download) 6.0 or higher > - [Git](https://git-scm.com/) Make sure you have [.NET SDK](https://dotnet.microsoft.com/en-us/download) installed, then open a terminal and enter the following command to install the latest DocFX: @@ -61,20 +61,20 @@ To preview changes, open a console window and call the `docfx build` command wit ```bash docfx build D:/dotnet-eud/docfx.json --serve ``` -Docfx produces static HTML files under the _site folder ready for publishing to any static site hosting servers. Deploy the created documentation to a web server or browse the documentation directly from local file system. To begin, you can refer to the DocFX documentation: [Publish to GitHub Pages](https://dotnet.github.io/docfx/index.html#publish-to-github-pages). +DocFX produces static HTML files under the *_site* folder ready to publish to any static site hosting server. Deploy the created documentation to a web server or browse the documentation directly from the local file system. For more information, refer to the DocFX documentation: [Publish to GitHub Pages](https://dotnet.github.io/docfx/index.html#publish-to-github-pages). ### Build PDF Files If your end users require a printed version, you can build a PDF file. You can configure PDF file generation in several ways. -The resulted PDF file will be located near *toc.yml* in the *_site* folder. +The resulted PDF file will be located next to the *toc.yml* file in the *_site* folder. -#### Build locally +#### Build Locally Open the console and call `docfx pdf D:\test-eud\docfx.json`. You need a succeeded build before you proceed. -#### docfx.json +#### Use docfx.json Include the `pdf` command to _docfx.json_. @@ -102,7 +102,7 @@ You can generate PDF only for a specific _toc.yml_: } ``` -#### toc.yml +#### Use toc.yml Include the `pdf` command to _toc.yml_ to generate PDF according to this table of content: