doc: generating apidoc and userguide for TcLog

.Zeugwerk/config.json

@@ -0,0 +1,24 @@
+{
+  "fileversion": 1,
+  "solution": "TcLog.sln",
+  "projects": [
+    {
+      "name": "TcLogProj",
+      "plcs": [
+        {
+          "version": "0.2.2",
+          "name": "TcLog",
+          "type": "Library",
+          "frameworks": {},
+          "references": {},
+          "repositories": [],
+          "bindings": {},
+          "patches": {
+            "platform": {},
+            "argument": {}
+          }
+        }
+      ]
+    }
+  ]
+}

.github/workflows/documentation.yml

@@ -0,0 +1,26 @@
+name: Documentation
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'documentation/**'
+      - 'TcLog/**'
+  pull_request:
+  workflow_dispatch:
+jobs:
+  Build:
+    name: Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Build
+        uses: Zeugwerk/[email protected]
+        with:
+          username: ${{ secrets.ACTIONS_ZGWK_USERNAME }}
+          password: ${{ secrets.ACTIONS_ZGWK_PASSWORD }}
+          filepath: "."
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          publish_dir: archive/documentation/html

documentation/docfx.json

@@ -0,0 +1,33 @@
+{
+  "build": {
+    "content": [
+      {
+        "files": [
+          "userguide/*.md",
+          "userguide/toc.yml",      
+          "reference/**/*.md",
+          "reference/toc.yml",
+          "reference/**/toc.yml",
+          "toc.yml",
+          "*.md"
+        ]
+      }
+    ],
+    "resource": [
+      {
+        "files": ["images/**"]
+      }
+    ],
+    "dest": "html",
+    "fileMetadataFiles": [],
+    "template": [
+      "statictoc", "template"
+    ],
+    "postProcessors": [],
+    "markdownEngineName": "markdig",
+    "noLangKeyword": false,
+    "keepFileLink": false,
+    "cleanupCacheHistory": false,
+    "disableGitFeatures": false
+  }
+}

documentation/index.md

@@ -0,0 +1,25 @@
+# TcLog
+
+<div align="center">
+  <h3 align="center">
+    TcLog
+  </h3>
+</div>
+
+Example Documentation
+
+## Why ThisLicense
+License Infos
+
+## Install TcLog
+How to install TcLog
+<button onClick="location.href='userguide/installation.html'" type="button">Install TcLog.</button>
+
+## Getting started
+How to use, first hands on...
+<button onClick="location.href='userguide/getStarted.html'" type="button">Get Started.</button>
+
+## Documentation
+The API reference of TcLog.
+
+<button onClick="location.href='reference/TcLog/Constants.html'" type="button">Read the docs.</button>

documentation/metadata.json

@@ -0,0 +1,5 @@
+{
+    "_appTitle": "TcLog",
+    "_appFooter": "(c) 2023 Ben Geisler - Documentation powered by <a href=\"http://zeugwerk.at\">Zeugwerk GmbH</a>",
+    "_disableContribution": false
+}

documentation/toc.yml

@@ -0,0 +1,4 @@
+- name: User guide
+  href: userguide/
+- name: API Reference
+  href: reference/

documentation/userguide/example1.md

@@ -0,0 +1,2 @@
+# Example 1
+tbd

documentation/userguide/example2.md

@@ -0,0 +1,2 @@
+# Example 2
+tbd

documentation/userguide/installation.md

@@ -0,0 +1,8 @@
+# Getting started
+tbd
+
+## Installation
+tbd
+
+## PLC
+tbd

documentation/userguide/license.md

@@ -0,0 +1,2 @@
+# License
+tbd

documentation/userguide/notices.md

@@ -0,0 +1,2 @@
+# Notices
+tbd

documentation/userguide/toc.yml

@@ -0,0 +1,12 @@
+- name: Installation
+  href: installation.md
+- name: Examples
+  items: 
+  - name: Example 1
+    href: example1.md
+  - name: Example 2
+    href: example2.md
+- name: License
+  href: license.md
+- name: Notices
+  href: notices.md