Skip to content

Commit 52e04d9

Browse files
committed
Update documentation workflow
1 parent b03315d commit 52e04d9

File tree

4 files changed

+49
-55
lines changed

4 files changed

+49
-55
lines changed

.documentation/docfx.json

Lines changed: 31 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,44 @@
11
{
2-
"metadata": [{
3-
"src": [{
4-
"files": "Postgrest.csproj",
5-
"exclude": ["**/bin/**", "**/obj/**"],
6-
"src": "../Postgrest"
7-
}],
8-
"dest": "api",
9-
"disableGitFeatures": false,
10-
"disableDefaultFilter": false
11-
}],
2+
"metadata": [
3+
{
4+
"src": [
5+
{
6+
"src": "../Postgrest",
7+
"files": [
8+
"**/*.csproj"
9+
]
10+
}
11+
],
12+
"dest": "api"
13+
}
14+
],
1215
"build": {
13-
"content": [{
16+
"content": [
17+
{
1418
"files": [
15-
"api/**.yml",
16-
"api/index.md"
19+
"**/*.{md,yml}"
20+
],
21+
"exclude": [
22+
"_site/**"
1723
]
18-
},
24+
}
25+
],
26+
"resource": [
1927
{
2028
"files": [
21-
"articles/**.md",
22-
"articles/**/toc.yml",
23-
"toc.yml",
24-
"*.md"
29+
"images/**"
2530
]
2631
}
2732
],
28-
"resource": [{
29-
"files": [
30-
"images/**"
31-
]
32-
}],
33-
"overwrite": [{
34-
"files": [
35-
"apidoc/**.md"
36-
],
37-
"exclude": [
38-
"obj/**",
39-
"_site/**"
40-
]
41-
}],
42-
"dest": "_site",
43-
"globalMetadataFiles": [],
44-
"fileMetadataFiles": [],
33+
"output": "_site",
4534
"template": [
46-
"default"
35+
"default",
36+
"modern"
4737
],
48-
"postProcessors": [],
49-
"markdownEngineName": "markdig",
50-
"noLangKeyword": false,
51-
"keepFileLink": false,
52-
"cleanupCacheHistory": false,
53-
"disableGitFeatures": false
38+
"globalMetadata": {
39+
"_appName": "postgrest-csharp",
40+
"_appTitle": "postgrest-csharp",
41+
"_enableSearch": true
42+
}
5443
}
5544
}

.documentation/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
_layout: landing
3+
---
4+
15
# postgrest-csharp
26

37
![Build And Test](https://github.com/supabase/postgrest-csharp/workflows/Build%20And%20Test/badge.svg)

.documentation/toc.yml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,2 @@
1-
- name: Articles
2-
href: articles/
3-
- name: Api Documentation
1+
- name: API
42
href: api/
5-
homepage: api/index.md

.github/workflows/build-documentation.yaml

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,23 @@ jobs:
1010
docs:
1111
runs-on: ubuntu-latest
1212
steps:
13-
- uses: actions/checkout@v2
13+
- uses: actions/checkout@v3
1414
with:
1515
persist-credentials: false
1616

17-
- uses: nikeee/docfx-action@v1.0.0
18-
name: Build Documentation
17+
- name: Setup .NET
18+
uses: actions/setup-dotnet@v3
1919
with:
20-
args: .documentation/docfx.json
20+
dotnet-version: 8.x
21+
22+
- name: Install docfx
23+
run: dotnet tool update -g docfx
24+
25+
- name: Build documentation
26+
run: docfx .documentation/docfx.json
2127

2228
- name: Deploy 🚀
23-
uses: JamesIves/github-pages-deploy-action@3.7.1
29+
uses: JamesIves/github-pages-deploy-action@v4
2430
with:
25-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
26-
BRANCH: gh-pages
27-
FOLDER: .documentation/_site # The folder the action should deploy.
28-
CLEAN: true # Automatically remove deleted files from the deploy branch
31+
folder: .documentation/_site
32+
token: ${{ secrets.GITHUB_TOKEN }}

0 commit comments

Comments
 (0)