oliverbooth/X10D
oliverbooth
/
X10D
mirror of https://github.com/oliverbooth/X10D
1
0
Fork 0
Code Issues

docs: add favicon and app title to docfx project

This commit is contained in:
Oliver Booth 2023-04-13 02:31:21 +01:00
parent 1be3f75538
commit 2f5d1aee4c
No known key found for this signature in database
GPG Key ID: 20BEB9DC87961025
2 changed files with 30 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
.github/workflows/docfx.yml vendored
View File

@ -9,13 +9,19 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
name: Publish Documentation name: Publish Documentation
steps: steps:
- uses: actions/checkout@v3 - name: Checkout
- uses: nikeee/docfx-action@v1.0.0 uses: actions/checkout@v3
name: Build Documentation
- name: Copy favicon
run: cp brandin_Icon.png docfx_project/images/favicon.png
- name: Build documentation
uses: nikeee/docfx-action@v1.0.0
with: with:
args: docfx_project/docfx.json args: docfx_project/docfx.json
- uses: maxheld83/ghpages@master
name: Publish Documentation on GitHub Pages - name: Publish documentation on GitHub Pages
uses: maxheld83/ghpages@master
env: env:
BUILD_DIR: docfx_project/_site BUILD_DIR: docfx_project/_site
GH_PAT: ${{ secrets.GH_PAT }} GH_PAT: ${{ secrets.GH_PAT }}

14
docfx_project/docfx.json
View File

@ -51,7 +51,19 @@
} }
], ],
"dest": "_site", "dest": "_site",
"globalMetadataFiles": [], "globalMetadata": {
"_appTitle": "X10D",
"_appName": "X10D",
"_appFaviconPath": "images/favicon.png",
"_appLogoPath": "images/favicon.png",
"_appFooter": "<strong>DocFX + Singulink = ♥</strong>",
"_copyrightFooter": "© Singulink. All rights reserved.",
"_enableSearch": true,
"_disableSideFilter": false,
"_enableNewTab": true,
"_disableContribution": false,
"_disableBreadcrumb": false,
},
"fileMetadataFiles": [], "fileMetadataFiles": [],
"template": [ "template": [
"default", "templates/singulinkfx" "default", "templates/singulinkfx"