Skip to content

Commit 2edde0c

Browse files
committed
Add OP Configuration
1 parent 159d121 commit 2edde0c

6 files changed

+94
-14
lines changed

.openpublishing.build.ps1

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
param(
2+
[string]$buildCorePowershellUrl = "https://opbuildstoragesandbox2.blob.core.windows.net/opps1container/.openpublishing.buildcore.ps1",
3+
[string]$parameters
4+
)
5+
# Main
6+
$errorActionPreference = 'Stop'
7+
8+
# Step-1 Download buildcore script to local
9+
echo "download build core script to local with source url: $buildCorePowershellUrl"
10+
$repositoryRoot = Split-Path -Parent $MyInvocation.MyCommand.Definition
11+
$buildCorePowershellDestination = "$repositoryRoot\.openpublishing.buildcore.ps1"
12+
Invoke-WebRequest $buildCorePowershellUrl -OutFile $buildCorePowershellDestination
13+
14+
# Step-2: Run build core
15+
echo "run build core script with parameters: $parameters"
16+
& "$buildCorePowershellDestination" "$parameters"
17+
exit $LASTEXITCODE

.openpublishing.publish.config.json

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
{
2+
"build_entry_point": "",
3+
"package_version": "latest-prerelease",
4+
"need_generate_pdf": false,
5+
"docsets_to_publish": [
6+
{
7+
"docset_name": "core-docs",
8+
"build_source_folder": null,
9+
"build_output_subfolder": ".",
10+
"build_entry_point": "docs.ps1",
11+
"locale": "en-us",
12+
"version": 0,
13+
"open_to_public_contributors": true,
14+
"type_mapping": {
15+
"Conceptual": "Content",
16+
"ManagedReference": "Content"
17+
}
18+
}
19+
],
20+
"dependent_repositories": [
21+
{
22+
"path_to_root": "api_ref",
23+
"url": "https://github.com/docascode/coreapi.git",
24+
"branch": "master"
25+
},
26+
{
27+
"path_to_root": "_themes",
28+
"url": "https://github.com/Microsoft/templates.docs.msft",
29+
"branch": "develop"
30+
}
31+
],
32+
"notification_subscribers": []
33+
}

apidoc/System.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
uid: System
3+
summary: This is *System* namespace.
4+
remarks: *content
5+
---
6+
7+
Add more content about *System* namespace here.

docfx.json

+20-8
Original file line numberDiff line numberDiff line change
@@ -30,34 +30,46 @@
3030
"content":
3131
[
3232
{
33-
"files": ["api/**/*.yml"]
33+
"files": ["*.yml"],
34+
"src": "api_ref",
35+
"dest": "core/api"
3436
},
3537
{
36-
"files": [
37-
"docs/**/*.md",
38-
"api/*.md"
39-
]
38+
"files": ["**/*.md"],
39+
"src": "docs",
40+
"dest": "core"
4041
},
4142
{
42-
"files": ["toc.yml"]
43+
"files": ["*.md"],
44+
"src": "api",
45+
"dest": "core/api"
46+
},
47+
{
48+
"files": ["toc.yml", "index.md"]
4349
}
4450
],
4551
"resource":
4652
[
4753
{
4854
"files": [
4955
"docs/images/**",
50-
"images/**"
56+
"images/**",
57+
"_themes/**"
58+
],
59+
"exclude": [
60+
"**/obj/**",
61+
"_themes/DocPacker/**"
5162
]
5263
}
5364
],
5465
"overwrite": "apidoc/*.md",
5566
"externalReference": [
5667
],
5768
"globalMetadata": {
69+
"breadcrumb_path": "/dotnet/toc.json",
5870
"_appTitle": "CoreCLR site"
5971
},
6072
"dest": "_site",
61-
"template": [ "default", "template" ]
73+
"template": [ "docs.html" ]
6274
}
6375
}

exclude.list

-6
This file was deleted.

index.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
layout: HubPage
3+
---
4+
5+
<article id="main">
6+
<section id="hero-content" class="graph">
7+
<h1>.NET Core</h1>
8+
<h2>Welcome to .NET Core documentation!</h2>
9+
</section>
10+
11+
<aside class="alert section-border">
12+
<ol class="action-list">
13+
<li><a href="docs/index" class="button-bordered button-translucent">Documentation</a></li>
14+
<li><a href="api/index" class="button-bordered button-translucent">API reference</a></li>
15+
</ol>
16+
</aside>
17+
</article>

0 commit comments

Comments
 (0)