Skip to content
This repository was archived by the owner on Sep 3, 2024. It is now read-only.

Commit 4b92e83

Browse files
Merge pull request #26 from thefringeninja/self-doc
Add Server Hosted Documentation
2 parents 19f07be + 6bdd5c3 commit 4b92e83

51 files changed

Lines changed: 1427 additions & 320 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -250,3 +250,6 @@ paket-files/
250250
# JetBrains Rider
251251
.idea/
252252
*.sln.iml
253+
254+
# Generated Schema Documentation
255+
**/Schema/*.schema.md

docs/docs.csproj

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<Project Sdk="Microsoft.NET.Sdk">
2+
<Sdk Name="Yarn.MSBuild" Version="1.7.0" />
3+
<PropertyGroup>
4+
<TargetFrameworks>netstandard2.0</TargetFrameworks>
5+
</PropertyGroup>
6+
<ItemGroup>
7+
<JsonSchemas Include="..\src\SQLStreamStore.HAL\**\Schema\*.schema.json" />
8+
</ItemGroup>
9+
<Target Name="YarnInstall" BeforeTargets="BeforeBuild">
10+
<Yarn Command="add @adobe/jsonschema2md@1.1.0 --exact --dev" />
11+
</Target>
12+
<Target Name="GenerateDocs" AfterTargets="YarnInstall">
13+
<Yarn Command="jsonschema2md --input ..\src\SQLStreamStore.HAL\%(JsonSchemas.RecursiveDir)%(JsonSchemas.Filename)%(JsonSchemas.Extension) --out ..\src\SQLStreamStore.HAL\%(JsonSchemas.RecursiveDir) --no-readme --schema-out=-" />
14+
</Target>
15+
</Project>

docs/package.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"devDependencies": {
3+
"@adobe/jsonschema2md": "1.1.0"
4+
}
5+
}

0 commit comments

Comments
 (0)