init

.github/workflows/build.yaml

@@ -0,0 +1,32 @@
+name: build
+
+on: [ push, pull_request ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup .NET 8 SDK
+        uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: 8.0.x
+      - name: restore
+        run: dotnet restore
+      - name: build
+        run: dotnet build --no-restore
+  # release to NuGet if push of tag
+  release:
+    runs-on: ubuntu-latest
+    needs: build
+    if: startsWith(github.ref, 'refs/tags/')
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup .NET 8 SDK
+        uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: 8.0.x
+      - name: pack
+        run: dotnet pack --configuration Release -o ./bin/nupkg
+      - name: push
+        run: dotnet nuget push ./bin/nupkg/*.nupkg -k ${{ secrets.NUGET_KEY }} -s https://api.nuget.org/v3/index.json

.github/workflows/docs.yaml

@@ -0,0 +1,42 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - '.github/workflows/docs.yml'
+      - 'docs/**'
+  pull_request:
+
+jobs:
+  deploy:
+    name: Deploy to GitHub Pages
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write    
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}    
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: yarn
+          cache-dependency-path: 'docs/yarn.lock'
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+        working-directory: ./docs
+      - name: Build website
+        run: yarn build
+        working-directory: ./docs
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        if: github.ref == 'refs/heads/master'
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/build

.gitignore

@@ -0,0 +1,16 @@
+bin/
+obj/
+/packages/
+riderModule.iml
+/_ReSharper.Caches/
+.idea/
+.vscode/
+/config.yaml
+/nupkg
+/.config/dotnet-tools.json
+
+/examples/*/.docusaurus
+/examples/*/node_modules
+/examples/*/docs/api
+/examples/*/api
+.vercel

.gitmodules

@@ -0,0 +1,6 @@
+[submodule "examples/discord-net-dfmg/Discord.Net"]
+	path = examples/discord-net-dfmg/Discord.Net
+	url = https://github.com/discord-net/Discord.Net
+[submodule "examples/docfx"]
+	path = examples/docfx
+	url = https://github.com/dotnet/docfx.git

DocFxToTemplate.sln

@@ -0,0 +1,34 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DocFxToTemplate", "src\DocFxToTemplate\DocFxToTemplate.csproj", "{7E4D53D2-3A2B-4DD4-9E7B-FB5C2A18C312}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DocFxToTemplate.Tool", "src\DocFxToTemplate.Tool\DocFxToTemplate.Tool.csproj", "{AC9E96F2-F0DB-421F-8CE4-291EEE985498}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DocFxToTemplate.Example1", "src\example\DocFxToTemplate.Example1\DocFxToTemplate.Example1.csproj", "{6058369A-DF5B-461B-8D60-32D485BD93B0}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DocFxToTemplate.Example2", "src\example\DocFxToTemplate.Example2\DocFxToTemplate.Example2.csproj", "{52D921A9-DD54-4C35-9774-F857DD3D54F6}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{7E4D53D2-3A2B-4DD4-9E7B-FB5C2A18C312}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{7E4D53D2-3A2B-4DD4-9E7B-FB5C2A18C312}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{7E4D53D2-3A2B-4DD4-9E7B-FB5C2A18C312}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{7E4D53D2-3A2B-4DD4-9E7B-FB5C2A18C312}.Release|Any CPU.Build.0 = Release|Any CPU
+		{AC9E96F2-F0DB-421F-8CE4-291EEE985498}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{AC9E96F2-F0DB-421F-8CE4-291EEE985498}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{AC9E96F2-F0DB-421F-8CE4-291EEE985498}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{AC9E96F2-F0DB-421F-8CE4-291EEE985498}.Release|Any CPU.Build.0 = Release|Any CPU
+		{6058369A-DF5B-461B-8D60-32D485BD93B0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{6058369A-DF5B-461B-8D60-32D485BD93B0}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{6058369A-DF5B-461B-8D60-32D485BD93B0}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{6058369A-DF5B-461B-8D60-32D485BD93B0}.Release|Any CPU.Build.0 = Release|Any CPU
+		{52D921A9-DD54-4C35-9774-F857DD3D54F6}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{52D921A9-DD54-4C35-9774-F857DD3D54F6}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{52D921A9-DD54-4C35-9774-F857DD3D54F6}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{52D921A9-DD54-4C35-9774-F857DD3D54F6}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+EndGlobal

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Karol Wójcik
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,6 @@
+# DocFxToTemplate
+
+DocFx YAML metadata to (scriban) template converter.
+
+Docs: https://k-wojcik.github.io/DocFxToTemplate
+Example: https://k-wojcik.github.io/DocFxToTemplate/docs/api