Skip to content

Commit eaee78f

Browse files
committed
docs: update docfx configuration for improved output structure and search functionality
1 parent a9d36ef commit eaee78f

File tree

1 file changed

+20
-22
lines changed

1 file changed

+20
-22
lines changed

docfx.json

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,42 @@
11
{
2+
"$schema": "https://raw.githubusercontent.com/dotnet/docfx/main/schemas/docfx.schema.json",
23
"metadata": [
34
{
45
"src": [
56
{
6-
"files": ["Yubico.Core.csproj"],
7-
"src": "./Yubico.Core/src/",
8-
"exclude": ["**/bin/**", "**/obj/**"]
7+
"files": ["**/Yubico.Core.csproj"],
8+
"src": "./Yubico.Core/src/"
99
}
1010
],
1111
"disableGitFeatures": true,
1212
"disableDefaultFilter": false,
13+
"namespaceLayout": "flattened",
1314
"memberLayout": "separatePages",
1415
"filter": "./docs/filterConfig.yml",
15-
"dest": "./docs/core-api",
16-
"properties": {
17-
"TargetFramework": "netstandard2.0"
18-
}
16+
"output": "./docs/core-api",
17+
"properties": { "TargetFramework": "netstandard2.0" }
1918
},
2019
{
2120
"src": [
2221
{
23-
"files": ["Yubico.YubiKey.csproj"],
24-
"src": "./Yubico.YubiKey/src/",
25-
"exclude": ["**/bin/**", "**/obj/**"]
22+
"files": ["**/Yubico.YubiKey.csproj"],
23+
"src": "./Yubico.YubiKey/src/"
2624
}
2725
],
2826
"disableGitFeatures": true,
2927
"disableDefaultFilter": false,
28+
"namespaceLayout": "flattened",
3029
"memberLayout": "separatePages",
3130
"filter": "./docs/filterConfig.yml",
32-
"dest": "./docs/yubikey-api",
33-
"properties": {
34-
"TargetFramework": "netstandard2.0"
35-
}
31+
"output": "./docs/yubikey-api",
32+
"properties": { "TargetFramework": "netstandard2.0" }
3633
}
3734
],
3835
"build": {
36+
"sitemap": {
37+
"baseUrl": "https://dotnet.github.io/docfx",
38+
"changefreq": "monthly"
39+
},
3940
"content": [
4041
{
4142
"files": [
@@ -64,18 +65,15 @@
6465
"src": "./docs/"
6566
}
6667
],
67-
"dest": "./docs/_site/",
68+
"output": "./docs/_site/",
6869
"globalMetadataFiles": [],
6970
"globalMetadata": {
70-
"_appFaviconPath": "images/favicon.ico"
71+
"_appFaviconPath": "images/favicon.ico",
72+
"_enableSearch": true
7173
},
7274
"fileMetadataFiles": [],
73-
"template": ["default", "./docs/memberpage", "./docs/yubikeysdk-template"],
74-
"postProcessors": [],
75-
"markdownEngineName": "markdig",
76-
"noLangKeyword": false,
77-
"keepFileLink": false,
78-
"cleanupCacheHistory": false,
75+
"template": ["default", "./docs/yubikeysdk-template"],
76+
"postProcessors": ["ExtractSearchIndex"],
7977
"disableGitFeatures": false
8078
}
8179
}

0 commit comments

Comments
 (0)