diff --git a/.github/workflows/ghpages.yml b/.github/workflows/ghpages.yml index fb85762..a42c873 100644 --- a/.github/workflows/ghpages.yml +++ b/.github/workflows/ghpages.yml @@ -32,6 +32,8 @@ jobs: .tools/omd/generateomd /source=src/NmeaParser /output=artifacts/docs/api/omd.html - name: Build Documentation + env: + DOCFX_SOURCE_BRANCH_NAME: master run: .tools/docfx/docfx.exe docs/docfx.json - name: Publish Documentation diff --git a/docs/docfx.json b/docs/docfx.json index 6b4376b..cade1c5 100644 --- a/docs/docfx.json +++ b/docs/docfx.json @@ -16,7 +16,7 @@ { "files": [ "NmeaParser/NmeaParser.csproj" ], "src" : "../src/" - }, + } ], "dest": "../artifacts/docs/api/netfx", "properties": { "TargetFramework": "net451" }, @@ -27,7 +27,7 @@ { "files": [ "NmeaParser/NmeaParser.csproj" ], "src" : "../src/" - }, + } ], "dest": "../artifacts/docs/api/netcore", "properties": { "TargetFramework": "netcoreapp2.1" }, @@ -38,7 +38,7 @@ { "files": [ "NmeaParser/NmeaParser.csproj" ], "src" : "../src/" - }, + } ], "dest": "../artifacts/docs/api/android", "properties": { "TargetFramework": "monoandroid70" }, @@ -49,7 +49,7 @@ { "files": [ "NmeaParser/NmeaParser.csproj" ], "src" : "../src/" - }, + } ], "dest": "../artifacts/docs/api/ios", "properties": { "TargetFramework": "xamarinios10" }, @@ -60,7 +60,7 @@ { "files": [ "NmeaParser/NmeaParser.csproj" ], "src" : "../src/" - }, + } ], "dest": "../artifacts/docs/api/uwp", "properties": { "TargetFramework": "uap10.0.16299" }, @@ -94,7 +94,8 @@ "resource": [ { "files": [ - "images/**" + "images/**", + "favicon.ico" ] }, { @@ -115,6 +116,12 @@ ] } ], + "globalMetadata": { + "_appLogoPath": "logo.png", + "_gitContribute": { + "branch": "master" + } + }, "dest": "../artifacts/docs_site", "globalMetadataFiles": [], "fileMetadataFiles": [], diff --git a/docs/favicon.ico b/docs/favicon.ico new file mode 100644 index 0000000..49aee22 Binary files /dev/null and b/docs/favicon.ico differ diff --git a/docs/images/logo.png b/docs/images/logo.png new file mode 100644 index 0000000..206f699 Binary files /dev/null and b/docs/images/logo.png differ diff --git a/src/NmeaParser/NmeaParser.csproj b/src/NmeaParser/NmeaParser.csproj index 3d6e6e0..19a6c64 100644 --- a/src/NmeaParser/NmeaParser.csproj +++ b/src/NmeaParser/NmeaParser.csproj @@ -28,6 +28,8 @@ true true enable + logo.png + @@ -66,6 +68,10 @@ + + + + diff --git a/src/NmeaParser/logo.png b/src/NmeaParser/logo.png new file mode 100644 index 0000000..0c758a9 Binary files /dev/null and b/src/NmeaParser/logo.png differ