1
0
mirror of https://github.com/oliverbooth/X10D synced 2024-11-09 22:55:42 +00:00

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

View File

@ -9,14 +9,20 @@ 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
with: - name: Copy favicon
args: docfx_project/docfx.json run: cp brandin_Icon.png docfx_project/images/favicon.png
- uses: maxheld83/ghpages@master
name: Publish Documentation on GitHub Pages - name: Build documentation
env: uses: nikeee/docfx-action@v1.0.0
BUILD_DIR: docfx_project/_site with:
GH_PAT: ${{ secrets.GH_PAT }} args: docfx_project/docfx.json
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Publish documentation on GitHub Pages
uses: maxheld83/ghpages@master
env:
BUILD_DIR: docfx_project/_site
GH_PAT: ${{ secrets.GH_PAT }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

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"