-
Notifications
You must be signed in to change notification settings - Fork 859
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
15 changed files
with
334 additions
and
1,137 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003"> | ||
<PropertyGroup> | ||
<BuildDocToolPath>$(MSBuildThisFileDirectory)..\tools\docfx.exe</BuildDocToolPath> | ||
<DocfxConfigFile Condition=" '$(DocfxConfigFile)' == '' ">$(MSBuildProjectDirectory)/docfx.json</DocfxConfigFile> | ||
<PreviewPort Condition=" '$(PreviewPort)' == '' ">8002</PreviewPort> | ||
<IsServing Condition="'$(IsServing)'==''">False</IsServing> | ||
<PreviewOutputFolder Condition=" '$(PreviewOutputFolder)' == '' ">$(OutputFolder)/_site</PreviewOutputFolder> | ||
<LogFile Condition=" '$(LogFile)' == '' ">log.txt</LogFile> | ||
<LogLevel Condition=" '$(LogLevel)' == '' ">Verbose</LogLevel> | ||
|
||
<!-- Website project's output directory is current folder, disable it as a temp workaround until a better way is found--> | ||
<CopyToOutput>False</CopyToOutput> | ||
<RebuildDoc Condition=" '$(RebuildDoc)' == '' ">False</RebuildDoc> | ||
</PropertyGroup> | ||
<Target Name="DocRebuild"> | ||
<CallTarget Targets="DocClean"/> | ||
<CallTarget Targets="DocBuild"/> | ||
</Target> | ||
<Target Name="DocBuild" AfterTargets="Build"> | ||
<CallTarget Targets="DocValidation"/> | ||
<CallTarget Targets="DocGenerateMetadata"/> | ||
</Target> | ||
<Target Name="DocValidation"> | ||
<Error Condition="!Exists($(BuildDocToolPath))" Text="docfx.exe is not found! Please check docfx.exe exists in tools folder of the package!"/> | ||
</Target> | ||
<Target Name="DocClean" DependsOnTargets="DocSetRebuildXDocParameter" AfterTargets="Clean"> | ||
</Target> | ||
<Target Name="DocSetRebuildXDocParameter"> | ||
<PropertyGroup> | ||
<RebuildDoc>True</RebuildDoc> | ||
</PropertyGroup> | ||
</Target> | ||
<Target Name="DocServe"> | ||
<Exec Command="start cmd /c ""$(BuildDocToolPath)" serve "$(PreviewOutputFolder)"" /> | ||
</Target> | ||
<Target Name="DocPreview"> | ||
<Exec Condition="$(IsServing)" Command="start cmd /c ""$(BuildDocToolPath)" build "$(DocfxConfigFile)" -o "$(PreviewOutputFolder)" --template "$(DocTemplate)" --serve -l "$(LogFile)" --logLevel "$(LogLevel)""" /> | ||
<Exec Condition="!$(IsServing)" Command=""$(BuildDocToolPath)" build "$(DocfxConfigFile)" -o "$(PreviewOutputFolder)" --template "$(DocTemplate)" -l "$(LogFile)" --logLevel "$(LogLevel)"" /> | ||
</Target> | ||
|
||
<!-- ************************************************************************* --> | ||
<!-- *************************** GenerateMetadata Phase ********************** --> | ||
<!-- ************************************************************************* --> | ||
<Target Name="DocGenerateMetadata" > | ||
<PropertyGroup> | ||
<DocGenerateCommand>"$(BuildDocToolPath)" "$(DocfxConfigFile)" -o "$(OutputFolder)" -l "$(LogFile)" --logLevel "$(LogLevel)"</DocGenerateCommand> | ||
<DocGenerateCommand Condition="$(RebuildDoc)">$(DocGenerateCommand) -f</DocGenerateCommand> | ||
<DocGenerateCommand Condition="'$(DocTemplate)' != ''">$(DocGenerateCommand) --template "$(DocTemplate)" </DocGenerateCommand> | ||
<DocGenerateCommand Condition="'$(DocParameters)' != ''">$(DocGenerateCommand) $(DocParameters)</DocGenerateCommand> | ||
</PropertyGroup> | ||
<Message Text="Executing $(DocGenerateCommand)" /> | ||
<Exec Command="$(DocGenerateCommand)"></Exec> | ||
</Target> | ||
</Project> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
|
||
############### | ||
# folder # | ||
############### | ||
/**/DROP/ | ||
/**/TEMP/ | ||
/**/packages/ | ||
/**/bin/ | ||
/**/obj/ | ||
_site |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
|
||
############### | ||
# temp file # | ||
############### | ||
*.yml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
|
||
# PLACEHOLDER | ||
TODO: Add .NET projects to *src* folder and run `docfx` to generate a **REAL** *API Documentation*! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
|
||
# Add your introductions here! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
#[Introduction](intro.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
{ | ||
"metadata": [ | ||
{ | ||
"src": [ | ||
{ | ||
"files": [ | ||
"*.csproj" | ||
], | ||
"cwd": ".", | ||
"exclude": [ | ||
"**/obj/**", | ||
"**/bin/**", | ||
"_site/**" | ||
] | ||
} | ||
], | ||
"dest": "obj/api" | ||
} | ||
], | ||
"build": { | ||
"content": [ | ||
{ | ||
"files": [ | ||
"api/**.yml" | ||
], | ||
"cwd": "obj" | ||
}, | ||
{ | ||
"files": [ | ||
"api/*.md", | ||
"articles/**.md", | ||
"toc.yml", | ||
"*.md" | ||
], | ||
"exclude": [ | ||
"obj/**", | ||
"_site/**" | ||
] | ||
} | ||
], | ||
"resource": [ | ||
{ | ||
"files": [ | ||
"images/**" | ||
], | ||
"exclude": [ | ||
"obj/**", | ||
"_site/**" | ||
] | ||
} | ||
], | ||
"overwrite": [ | ||
{ | ||
"files": [ | ||
"apidoc/**.md" | ||
], | ||
"exclude": [ | ||
"obj/**", | ||
"_site/**" | ||
] | ||
} | ||
], | ||
"dest": "_site", | ||
"template": [ | ||
"default" | ||
] | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
|
||
# This is the **HOMEPAGE**. | ||
Refer to [Markdown](http://daringfireball.net/projects/markdown/) for how to write markdown files. | ||
## Quick Start Notes: | ||
1. Add images to *images* folder if the file is referencing an image. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
|
||
- name: Articles | ||
href: articles/ | ||
- name: API Documentation | ||
href: obj/api/ | ||
homepage: api/index.md |
Oops, something went wrong.