Skip to content

Commit c8c4477

Browse files
committed
add docfx documentation boilerplate
1 parent cca63da commit c8c4477

File tree

11 files changed

+763
-3
lines changed

11 files changed

+763
-3
lines changed

.gitignore

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,6 @@
33
*.user
44
.couscous/
55
docs/Template-Dark/
6-
.idea/
6+
.idea/
7+
**/_site/
8+
log.txt

JsonApiDotnetCore.sln

+3-2
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ EndProject
1515
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{C5B4D998-CECB-454D-9F32-085A897577BE}"
1616
ProjectSection(SolutionItems) = preProject
1717
.gitignore = .gitignore
18+
Directory.Build.props = Directory.Build.props
1819
README.md = README.md
1920
EndProjectSection
2021
EndProject
@@ -160,9 +161,9 @@ Global
160161
EndGlobalSection
161162
GlobalSection(NestedProjects) = preSolution
162163
{C0EC9E70-EB2E-436F-9D94-FA16FA774123} = {7A2B7ADD-ECB5-4D00-AA6A-D45BD11C97CF}
163-
{97EE048B-16C0-43F6-BDA9-4E762B2F579F} = {7A2B7ADD-ECB5-4D00-AA6A-D45BD11C97CF}
164+
{97EE048B-16C0-43F6-BDA9-4E762B2F579F} = {026FBC6C-AF76-4568-9B87-EC73457899FD}
164165
{0B959765-40D2-43B5-87EE-FE2FEF9DBED5} = {24B15015-62E5-42E1-9BA0-ECE6BE7AA15F}
165-
{570165EC-62B5-4684-A139-8D2A30DD4475} = {7A2B7ADD-ECB5-4D00-AA6A-D45BD11C97CF}
166+
{570165EC-62B5-4684-A139-8D2A30DD4475} = {026FBC6C-AF76-4568-9B87-EC73457899FD}
166167
{73DA578D-A63F-4956-83ED-6D7102E09140} = {24B15015-62E5-42E1-9BA0-ECE6BE7AA15F}
167168
{6D4BD85A-A262-44C6-8572-FE3A30410BF3} = {24B15015-62E5-42E1-9BA0-ECE6BE7AA15F}
168169
{026FBC6C-AF76-4568-9B87-EC73457899FD} = {7A2B7ADD-ECB5-4D00-AA6A-D45BD11C97CF}

src/JsonApiDotNetCore/JsonApiDotNetCore.csproj

+4
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,11 @@
1313
<RepositoryType>git</RepositoryType>
1414
<RepositoryUrl>https://github.com/json-api-dotnet/JsonApiDotNetCore</RepositoryUrl>
1515
</PropertyGroup>
16+
<PropertyGroup Condition="'$(Configuration)|$(TargetFramework)|$(Platform)'=='Release|netstandard2.0|AnyCPU'">
17+
<DocumentationFile>bin\Release\netstandard2.0\JsonApiDotNetCore.xml</DocumentationFile>
18+
</PropertyGroup>
1619
<ItemGroup>
20+
<PackageReference Include="docfx.console" Version="2.33.0" />
1721
<PackageReference Include="Microsoft.AspNetCore.Routing" Version="$(AspNetCoreVersion)" />
1822
<PackageReference Include="Microsoft.AspNetCore.Mvc" Version="$(AspNetCoreVersion)" />
1923
<PackageReference Include="Microsoft.EntityFrameworkCore" Version="$(EFCoreVersion)" />

src/JsonApiDotNetCore/api/.gitignore

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
###############
2+
# temp file #
3+
###############
4+
*.yml

src/JsonApiDotNetCore/api/.manifest

+683
Large diffs are not rendered by default.

src/JsonApiDotNetCore/api/index.md

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# PLACEHOLDER
2+
TODO: Add .NET projects to the *src* folder and run `docfx` to generate **REAL** *API Documentation*!
+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Add your introductions here!
+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
- name: Introduction
2+
href: intro.md

src/JsonApiDotNetCore/docfx.json

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
{
2+
"metadata": [
3+
{
4+
"src": [
5+
{
6+
"files": [ "**.csproj" ],
7+
"src": "C:\\Users\\jnance\\dev\\json-api-dotnet-core\\src\\JsonApiDotNetCore"
8+
}
9+
],
10+
"dest": "api",
11+
"disableGitFeatures": false,
12+
"properties": {
13+
"targetFramework": "netstandard2.0"
14+
}
15+
}
16+
],
17+
"build": {
18+
"content": [
19+
{
20+
"files": [ "api/**.yml", "api/index.md" ]
21+
},
22+
{
23+
"files": [
24+
"articles/**.md",
25+
"articles/**/toc.yml",
26+
"toc.yml",
27+
"*.md"
28+
]
29+
}
30+
],
31+
"resource": [
32+
{
33+
"files": [ "images/**" ]
34+
}
35+
],
36+
"overwrite": [
37+
{
38+
"files": [ "apidoc/**.md" ],
39+
"exclude": [ "obj/**", "_site/**" ]
40+
}
41+
],
42+
"dest": "_site",
43+
"globalMetadataFiles": [],
44+
"fileMetadataFiles": [],
45+
"template": [ "default" ],
46+
"postProcessors": [],
47+
"noLangKeyword": false,
48+
"keepFileLink": false,
49+
"cleanupCacheHistory": false,
50+
"disableGitFeatures": false
51+
}
52+
}

src/JsonApiDotNetCore/index.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# This is the **HOMEPAGE**.
2+
Refer to [Markdown](http://daringfireball.net/projects/markdown/) for how to write markdown files.
3+
## Quick Start Notes:
4+
1. Add images to the *images* folder if the file is referencing an image.

src/JsonApiDotNetCore/toc.yml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
- name: Articles
2+
href: articles/
3+
- name: Api Documentation
4+
href: api/
5+
homepage: api/index.md

0 commit comments

Comments
 (0)