webexpress-framework · ReneSchwarzer · Apr 18, 2025 · Jul 7, 2024 · Jul 7, 2024 · Jul 7, 2024
diff --git a/.github/workflows/generate-docs.yml b/.github/workflows/generate-docs.yml
@@ -0,0 +1,52 @@
+name: Generate and Deploy Documentation
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  actions: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  publish-docs:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+
+    - name: Setup .NET SDK
+      uses: actions/setup-dotnet@v3
+      with:
+        dotnet-version: 9.x
+
+    - name: Install DocFX
+      run: dotnet tool install -g docfx
+
+    - name: Add DocFX to PATH
+      run: echo "$HOME/.dotnet/tools" >> $GITHUB_PATH
+
+    - name: Generate documentation
+      run: |
+        cd docs 
+        docfx metadata
+        docfx build
+
+    - name: Upload artifact
+      uses: actions/upload-pages-artifact@v3
+      with:
+        path: '_site'
+
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v4
diff --git a/README.md b/README.md
@@ -1,49 +1,45 @@
 ![WebExpress](https://raw.githubusercontent.com/ReneSchwarzer/WebExpress/main/assets/banner.png)
 
 # WebExpress
-WebExpress is a lightweight web server optimized for use in low-performance environments (e.g. Rasperry PI). By providing 
+`WebExpress` is a lightweight web server optimized for use in low-performance environments (e.g. Rasperry PI). By providing 
 a powerful plugin system and a comprehensive API, web applications can be easily and quickly integrated into a .net 
-language (e.g. C#). Some advantages of WebExpress are:
+language (e.g. C#). Some advantages of `WebExpress` are:
 
 - It is easy to use.
 - It offers a variety of features and tools that can help you build and manage your website.
 - It is fast and efficient and can help you save time and money.
 - It is flexible and can be customized to meet your specific requirements.
 
-The WebExpress family includes the following projects:
+The `WebExpress` family includes the following projects:
 
-- [WebExpress](https://github.com/ReneSchwarzer/WebExpress#readme) - The web server for WebExpress applications and the documentation.
-- [WebExpress.WebCore](https://github.com/ReneSchwarzer/WebExpress.WebCore#readme) - The core for WebExpress applications.
-- [WebExpress.WebUI](https://github.com/ReneSchwarzer/WebExpress.WebUI#readme) - Common templates and controls for WebExpress applications.
-- [WebExpress.WebIndex](https://github.com/ReneSchwarzer/WebExpress.WebIndex#readme) - Reverse index for WebExpress applications.
-- [WebExpress.WebApp](https://github.com/ReneSchwarzer/WebExpress.WebApp#readme) - Business application template for WebExpress applications.
+- [WebExpress](https://github.com/ReneSchwarzer/WebExpress#readme) - The web server for `WebExpress` applications and the documentation.
+- [WebExpress.WebCore](https://github.com/ReneSchwarzer/WebExpress.WebCore#readme) - The core for `WebExpress` applications.
+- [WebExpress.WebUI](https://github.com/ReneSchwarzer/WebExpress.WebUI#readme) - Common templates and controls for `WebExpress` applications.
+- [WebExpress.WebIndex](https://github.com/ReneSchwarzer/WebExpress.WebIndex#readme) - Reverse index for `WebExpress` applications.
+- [WebExpress.WebApp](https://github.com/ReneSchwarzer/WebExpress.WebApp#readme) - Business application template for `WebExpress` applications.
 
 # WebExpress.WebUI
-WebExpress.WebUI is part of the WebExpress family. It provides templates and controls that standardize and facilitate the 
-creation of web pages.
-
-# Libraries used
-- https://github.com/dotnet/core (MIT)
-- https://getbootstrap.com/ (MIT)
-- https://www.chartjs.org (MIT)
-- https://jquery.com/ (MIT)
-- https://summernote.org/ (MIT)
-- https://popper.js.org/ (MIT)
-- https://github.com/kurtobando/simple-tags (MIT)
-- https://github.com/uxsolutions/bootstrap-datepicker (Apache 2.0)
-- https://github.com/xoofx/markdig (BSD-2-Clause license)
+`WebExpress.WebUI` is part of the WebExpress family. It provides templates and controls that standardize and facilitate the creation of web pages.
 
 # Download 
 The current binaries are available for download [here](https://github.com/ReneSchwarzer/WebExpress/releases).
 
 # Start
-To get started with WebExpress, use the following links and tutorials.
+If you're looking to get started with `WebExpress`, we would recommend using the following documentation. It can help you understand the platform.
 
-- [installation guide](https://github.com/ReneSchwarzer/WebExpress/blob/main/doc/installation_guide.md) 
-- [development guide](https://github.com/ReneSchwarzer/WebExpress/blob/main/doc/development_guide.md)
+- [Installation Guide](https://github.com/ReneSchwarzer/WebExpress/blob/main/doc/installation_guide.md) 
+- [Development Guide](https://github.com/ReneSchwarzer/WebExpress/blob/main/doc/development_guide.md)
+- [WebExpress.WebCore API Documentation](https://reneschwarzer.github.io/WebExpress.WebCore/) 
+- [WebExpress.WebUI API Documentation](https://reneschwarzer.github.io/WebExpress.WebUI/) 
+- [WebExpress.WebApp API Documentation](https://reneschwarzer.github.io/WebExpress.WebApp/) 
+- [WebExpress.WebIndex API Documentation](https://reneschwarzer.github.io/WebExpress.WebIndex/) 
+
+# Learning
+The following tutorials illustrate the essential techniques of `WebExpress`. These tutorials are designed to assist you, as a developer, in understanding the various aspects of `WebExpress`. Each tutorial provides a detailed, step-by-step guide that you can work through using an example. If you�re interested in beginning the development of `WebExpress` components, we would recommend you to complete some of these tutorials.
 
-## Tutorials
 - [HelloWorld](https://github.com/ReneSchwarzer/WebExpress.Tutorial.HelloWorld#readme)
+- [WebApp](https://github.com/ReneSchwarzer/WebExpress.Tutorial.WebApp#readme)
+- [WebIndex](https://github.com/ReneSchwarzer/WebExpress.Tutorial.WebIndex#readme)
 
 # Tags
-#NETCore #WebExpress #Controls #Templates
+#WebUI #WebExpress #DotNet #NETCore
diff --git a/docs/api/toc.yml b/docs/api/toc.yml
@@ -0,0 +1,2 @@
+### YamlMime:TableOfContent
+[]
diff --git a/docs/assets/webexpress.ico b/docs/assets/webexpress.ico
diff --git a/docs/assets/webexpress.svg b/docs/assets/webexpress.svg
diff --git a/docs/docfx.json b/docs/docfx.json
@@ -0,0 +1,61 @@
+{
+  "$schema": "https://raw.githubusercontent.com/dotnet/docfx/main/schemas/docfx.schema.json",
+  "metadata": [
+    {
+      "src": [
+        {
+          "files": [
+            "src/WebExpress.WebUI/*.csproj"
+          ],
+          "src": "../"
+        }
+      ],
+      "dest": "api",
+      "outputFormat": "apiPage"
+    }
+  ],
+  "build": {
+    "content": [
+      {
+        "files": [ "**/*.{md,yml}" ],
+        "exclude": [ "_site/**", "obj/**" ]
+      }
+    ],
+    "resource": [
+      {
+        "files": [ "**/images/**", "**/media/**", "codesnippet/**" ],
+        "exclude": [ "_site/**", "obj/**" ]
+      },
+      {
+        "files": [ "assets/webexpress.ico", "assets/webexpress.svg" ]
+      },
+      {
+        "src": "../schemas",
+        "files": [ "**/*.json" ],
+        "dest": "schemas"
+      }
+    ],
+    "postProcessors": [ "ExtractSearchIndex" ],
+    "globalMetadata": {
+      "_appTitle": "WebExpress.WebUI",
+      "_appName": "WebExpress.WebUI",
+      "_appFaviconPath": "assets/webexpress.ico", 
+      "_appLogoPath": "assets/webexpress.svg",
+      "pdf": false
+    },
+    "markdownEngineProperties": {
+      "alerts": {
+        "TODO": "alert alert-secondary"
+      }
+    },
+    "xref": [
+      "../.xrefmap.json"
+    ],
+    "output": "../_site",
+    "template": [
+      "default",
+      "modern",
+      "template"
+    ]
+  }
+}
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,30 @@
+![WebExpress](https://raw.githubusercontent.com/ReneSchwarzer/WebExpress/main/assets/banner.png)
+
+# WebExpress
+
+WebExpress is a lightweight web server optimized for use in low-performance environments (e.g. Raspberry PI). By providing 
+a powerful plugin system and a comprehensive API, web applications can be easily and quickly integrated into a .NET 
+language (e.g. C#). Some advantages of WebExpress are:
+
+- It is easy to use.
+- It offers a variety of features and tools that can help you build and manage your website.
+- It is fast and efficient and can help you save time and money.
+- It is flexible and can be customized to meet your specific requirements.
+
+The WebExpress family includes the following projects:
+
+- [WebExpress](https://github.com/ReneSchwarzer/WebExpress#readme) - The web server for WebExpress applications and the documentation.
+- [WebExpress.WebCore](https://github.com/ReneSchwarzer/WebExpress.WebCore#readme) - The core for WebExpress applications.
+- [WebExpress.WebUI](https://github.com/ReneSchwarzer/WebExpress.WebUI#readme) - Common templates and controls for WebExpress applications.
+- [WebExpress.WebIndex](https://github.com/ReneSchwarzer/WebExpress.WebIndex#readme) - Reverse index for WebExpress applications.
+- [WebExpress.WebApp](https://github.com/ReneSchwarzer/WebExpress.WebApp#readme) - Business application template for WebExpress applications.
+
+# WebExpress.WebUI
+`WebExpress.WebUI` is part of the WebExpress family. It provides templates and controls that standardize and facilitate the 
+creation of web pages.
+
+# Download 
+The current binaries are available for download [here](https://github.com/ReneSchwarzer/WebExpress/releases).
+
+# Tags
+#WebUI #WebExpress #DotNet #NETCore