-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
257 additions
and
81 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| name: Publish Documentation | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| - docfx_update | ||
|
|
||
| jobs: | ||
| build: | ||
| runs-on: ubuntu-22.04 | ||
|
|
||
| steps: | ||
| - name: Checkout repo | ||
| uses: actions/checkout@v2 | ||
| with: | ||
| fetch-depth: 1 | ||
|
|
||
| - name: Checkout docs host repo | ||
| uses: actions/checkout@v2 | ||
| with: | ||
| repository: ezEngine/docs | ||
| path: _site | ||
| fetch-depth: 1 | ||
| persist-credentials: false | ||
|
|
||
| - name: Setup .NET | ||
| uses: actions/setup-dotnet@v4 | ||
| with: | ||
| dotnet-version: 8.x | ||
|
|
||
| - name: Clear docs host repo | ||
| run: rm -rf _site/* | ||
|
|
||
| - name: Get docfx | ||
| run: | | ||
| dotnet tool update -g docfx | ||
| - name: Build docs | ||
| run: | | ||
| docfx build | ||
| cp CNAME _site/CNAME | ||
| - name: Commit | ||
| run: | | ||
| export GIT_COMMITTER_NAME=$(git show -s --format='%cn') | ||
| export GIT_COMMITTER_EMAIL=$(git show -s --format='%ce') | ||
| export GIT_AUTHOR_NAME=$(git show -s --format='%an') | ||
| export GIT_AUTHOR_EMAIL=$(git show -s --format='%ae') | ||
| export COMMIT_HASH=$(git show -s --format='%H') | ||
| export SUBJECT=$(git show -s --format='%s') | ||
| cd _site | ||
| git add . | ||
| git commit -m "$SUBJECT" -m "Original commit: $COMMIT_HASH" | ||
| - name: Push changes | ||
| uses: ad-m/github-push-action@master | ||
| with: | ||
| github_token: ${{ secrets.API_TOKEN_GITHUB }} | ||
| branch: main | ||
| directory: _site | ||
| repository: ezEngine/docs | ||
| force: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,171 @@ | ||
| {{!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)}} | ||
| <!DOCTYPE html> | ||
| <html {{#_lang}}lang="{{_lang}}"{{/_lang}}> | ||
| <head> | ||
| <meta charset="utf-8"> | ||
| {{#redirect_url}} | ||
| <meta http-equiv="refresh" content="0;URL='{{redirect_url}}'"> | ||
| {{/redirect_url}} | ||
| {{^redirect_url}} | ||
| <title>{{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}}</title> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> | ||
| <meta name="title" content="{{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}}"> | ||
| {{#_description}}<meta name="description" content="{{_description}}">{{/_description}} | ||
| <link rel="icon" href="{{_rel}}{{{_appFaviconPath}}}{{^_appFaviconPath}}favicon.ico{{/_appFaviconPath}}"> | ||
| <link rel="stylesheet" href="{{_rel}}public/docfx.min.css"> | ||
| <link rel="stylesheet" href="{{_rel}}public/main.css"> | ||
| <meta name="docfx:navrel" content="{{_navRel}}"> | ||
| <meta name="docfx:tocrel" content="{{_tocRel}}"> | ||
| {{#_noindex}}<meta name="searchOption" content="noindex">{{/_noindex}} | ||
| {{#_enableSearch}}<meta name="docfx:rel" content="{{_rel}}">{{/_enableSearch}} | ||
| {{#_disableNewTab}}<meta name="docfx:disablenewtab" content="true">{{/_disableNewTab}} | ||
| {{#_disableTocFilter}}<meta name="docfx:disabletocfilter" content="true">{{/_disableTocFilter}} | ||
| {{#docurl}}<meta name="docfx:docurl" content="{{docurl}}">{{/docurl}} | ||
| <meta name="loc:inThisArticle" content="{{__global.inThisArticle}}"> | ||
| <meta name="loc:searchResultsCount" content="{{__global.searchResultsCount}}"> | ||
| <meta name="loc:searchNoResults" content="{{__global.searchNoResults}}"> | ||
| <meta name="loc:tocFilter" content="{{__global.tocFilter}}"> | ||
| <meta name="loc:nextArticle" content="{{__global.nextArticle}}"> | ||
| <meta name="loc:prevArticle" content="{{__global.prevArticle}}"> | ||
| <meta name="loc:themeLight" content="{{__global.themeLight}}"> | ||
| <meta name="loc:themeDark" content="{{__global.themeDark}}"> | ||
| <meta name="loc:themeAuto" content="{{__global.themeAuto}}"> | ||
| <meta name="loc:changeTheme" content="{{__global.changeTheme}}"> | ||
| <meta name="loc:copy" content="{{__global.copy}}"> | ||
| <meta name="loc:downloadPdf" content="{{__global.downloadPdf}}"> | ||
| {{/redirect_url}} | ||
| </head> | ||
|
|
||
| {{^redirect_url}} | ||
| <script type="module" src="./{{_rel}}public/docfx.min.js"></script> | ||
|
|
||
| <script> | ||
| const theme = localStorage.getItem('theme') || 'auto' | ||
| document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme) | ||
| </script> | ||
|
|
||
| {{#_googleAnalyticsTagId}} | ||
| <script async src="https://www.googletagmanager.com/gtag/js?id={{_googleAnalyticsTagId}}"></script> | ||
| <script> | ||
| window.dataLayer = window.dataLayer || []; | ||
| function gtag() { dataLayer.push(arguments); } | ||
| gtag('js', new Date()); | ||
| gtag('config', '{{_googleAnalyticsTagId}}'); | ||
| </script> | ||
| {{/_googleAnalyticsTagId}} | ||
|
|
||
| <body class="tex2jax_ignore" data-layout="{{_layout}}{{layout}}" data-yaml-mime="{{yamlmime}}"> | ||
| <header class="bg-body border-bottom"> | ||
| <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> | ||
| <div class="container-xxl flex-nowrap"> | ||
| <a class="navbar-brand" href="{{_appLogoUrl}}{{^_appLogoUrl}}{{_rel}}index.html{{/_appLogoUrl}}"> | ||
| <!-- | ||
| <img id="logo" class="svg" src="{{_rel}}{{{_appLogoPath}}}{{^_appLogoPath}}logo.svg{{/_appLogoPath}}" alt="{{_appName}}" > | ||
| {{_appName}} | ||
| --> | ||
| <img id="logo" src="{{_rel}}{{{_appLogoPath}}}{{^_appLogoPath}}logo.svg{{/_appLogoPath}}" style="width: 100px; height: 50px;" alt="{{_appName}}" > | ||
| </a> | ||
| <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"> | ||
| <i class="bi bi-three-dots"></i> | ||
| </button> | ||
| <div class="collapse navbar-collapse" id="navpanel"> | ||
| <div id="navbar"> | ||
| {{#_enableSearch}} | ||
| <form class="search" role="search" id="search"> | ||
| <i class="bi bi-search"></i> | ||
| <input class="form-control" id="search-query" type="search" disabled placeholder="{{__global.search}}" autocomplete="off" aria-label="Search"> | ||
| </form> | ||
| {{/_enableSearch}} | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </nav> | ||
| </header> | ||
|
|
||
| <main class="container-xxl"> | ||
| <div class="toc-offcanvas"> | ||
| <div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel"> | ||
| <div class="offcanvas-header"> | ||
| <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5> | ||
| <button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button> | ||
| </div> | ||
| <div class="offcanvas-body"> | ||
| <nav class="toc" id="toc"></nav> | ||
| </div> | ||
| </div> | ||
| </div> | ||
|
|
||
| <div class="content"> | ||
| <div class="actionbar"> | ||
| <button class="btn btn-lg border-0 d-md-none" style="margin-top: -.65em; margin-left: -.8em" | ||
| type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" | ||
| aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents"> | ||
| <i class="bi bi-list"></i> | ||
| </button> | ||
|
|
||
| <nav id="breadcrumb"></nav> | ||
| </div> | ||
|
|
||
| <article data-uid="{{uid}}"> | ||
| {{!body}} | ||
| </article> | ||
|
|
||
| {{^_disableContribution}} | ||
| <div class="contribution d-print-none"> | ||
| {{#sourceurl}} | ||
| <a href="{{sourceurl}}" class="edit-link">{{__global.improveThisDoc}}</a> | ||
| {{/sourceurl}} | ||
| {{^sourceurl}}{{#docurl}} | ||
| <a href="{{docurl}}" class="edit-link">{{__global.improveThisDoc}}</a> | ||
| {{/docurl}}{{/sourceurl}} | ||
| </div> | ||
| {{/_disableContribution}} | ||
|
|
||
| {{^_disableNextArticle}} | ||
| <div class="next-article d-print-none border-top" id="nextArticle"></div> | ||
| {{/_disableNextArticle}} | ||
|
|
||
| </div> | ||
|
|
||
| <div class="affix"> | ||
| <nav id="affix"></nav> | ||
| </div> | ||
| </main> | ||
|
|
||
| {{#_enableSearch}} | ||
| <div class="container-xxl search-results" id="search-results"></div> | ||
| {{/_enableSearch}} | ||
|
|
||
| <footer class="border-top text-secondary"> | ||
| <div class="container-xxl"> | ||
| <div class="flex-fill"> | ||
| <!-- | ||
| {{{_appFooter}}}{{^_appFooter}}<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>{{/_appFooter}} | ||
| --> | ||
| <span class="pull-right"> | ||
| <a href="#top">{{__global.backToTop}}</a> | ||
| </span> | ||
| <span class="footer-logo"> | ||
| <a id="logo_ez" href="https://ezEngine.net"></a> | ||
| </span> | ||
| <span class="footer-logo"> | ||
| <a id="logo_github" href="https://github.com/ezEngine/ezEngine" target="_blank"></a> | ||
| </span> | ||
| <span class="footer-logo"> | ||
| <a id="logo_twitter" href="https://twitter.com/ezengineproject" target="_blank"></a> | ||
| </span> | ||
| <span class="footer-logo"> | ||
| <a id="logo_discord" href="https://discord.gg/rfJewc5khZ" target="_blank"></a> | ||
| </span> | ||
| <span class="footer-logo"> | ||
| <a id="logo_youtube" href="https://www.youtube.com/@ezEngine" target="_blank"></a> | ||
| </span> | ||
| </div> | ||
| </div> | ||
| </footer> | ||
| </body> | ||
| {{/redirect_url}} | ||
| </html> |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters