Skip to content

Commit 206e510

Browse files
committed
doc: add docfx
1 parent 8d9fa4e commit 206e510

File tree

3 files changed

+103
-0
lines changed

3 files changed

+103
-0
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -340,3 +340,6 @@ ASALocalRun/
340340
healthchecksdb
341341
/_old
342342
/src/samples/MsalClientTest/tests.cs
343+
344+
api/
345+
_site/

docfx.json

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
{
2+
"$schema": "https://raw.githubusercontent.com/dotnet/docfx/main/schemas/docfx.schema.json",
3+
"metadata": [
4+
{
5+
"src": [
6+
{
7+
"src": ".",
8+
"files": [
9+
"src/CmlLib.Core.Auth.Microsoft/CmlLib.Core.Auth.Microsoft.csproj",
10+
"src/CmlLib.Core.Auth.Microsoft.MojangLauncher/CmlLib.Core.Auth.Microsoft.MojangLauncher.csproj",
11+
"src/CmlLib.Core.Bedrock.Auth/CmlLib.Core.Bedrock.Auth.csproj",
12+
"src/XboxAuthNet.Game/XboxAuthNet.Game.csproj",
13+
"src/XboxAuthNet.Game.Msal/XboxAuthNet.Game.Msal.csproj",
14+
"src/XboxAuthNet.Game.WindowsSecurity/XboxAuthNet.Game.WindowsSecurity.csproj"
15+
]
16+
}
17+
],
18+
"dest": "api",
19+
"outputFormat": "markdown"
20+
}
21+
],
22+
"build": {
23+
"content": [
24+
{
25+
"files": [
26+
"**/*.{md,yml}"
27+
],
28+
"exclude": [
29+
"_site/**"
30+
]
31+
}
32+
],
33+
"resource": [
34+
{
35+
"files": [
36+
"images/**"
37+
]
38+
}
39+
],
40+
"output": "_site",
41+
"template": [
42+
"default",
43+
"modern"
44+
],
45+
"globalMetadata": {
46+
"_appName": "CmlLib.Core.Auth.Microsoft",
47+
"_appTitle": "CmlLib.Core.Auth.Microsoft",
48+
"_enableSearch": true,
49+
"pdf": false
50+
}
51+
}
52+
}

github/workflows/deploy.yml

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Your GitHub workflow file under .github/workflows/
2+
# Trigger the action on push to master
3+
on:
4+
push:
5+
branches:
6+
- master
7+
8+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
9+
permissions:
10+
actions: read
11+
pages: write
12+
id-token: write
13+
14+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
15+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
16+
concurrency:
17+
group: "pages"
18+
cancel-in-progress: false
19+
20+
jobs:
21+
publish-docs:
22+
environment:
23+
name: github-pages
24+
url: ${{ steps.deployment.outputs.page_url }}
25+
runs-on: ubuntu-latest
26+
steps:
27+
- name: Checkout
28+
uses: actions/checkout@v3
29+
- name: Dotnet Setup
30+
uses: actions/setup-dotnet@v3
31+
with:
32+
dotnet-version: 8.x
33+
34+
- run: dotnet tool update -g docfx
35+
- run: docfx metadata docfx.json
36+
- run: docfx docfx.json
37+
38+
- name: Copy Metadata into Site Folder
39+
run: cp -r api/* _site/api
40+
41+
- name: Upload site
42+
uses: actions/upload-pages-artifact@v3
43+
with:
44+
path: '_site'
45+
46+
- name: Deploy to GitHub Pages
47+
id: deployment
48+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)