webexpress-framework · ReneSchwarzer · Apr 18, 2025 · Jul 7, 2024 · Jul 8, 2024 · Jul 8, 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,37 +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.WebCore
-WebCore is part of the Webexpres family and includes the basic elements of a WebExpress application.
+`WebCore` is part of the `WebExpres` family and includes the basic elements of a `WebExpress` application.
 
 # 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
-#Raspberry #Raspbian #IoT #NETCore #WebExpress
+#WebCore #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.WebCore/*.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.WebCore",
+      "_appName": "WebExpress.WebCore",
+      "_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,28 @@
+![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.WebCore
+WebCore is part of the WebExpress family and includes the basic elements of a WebExpress application.
+
+# Download 
+The current binaries are available for download [here](https://github.com/ReneSchwarzer/WebExpress/releases).
+
+# Tags
+#Raspberry #Raspbian #IoT #NETCore #WebExpress
diff --git a/docs/template/dashboard.html.tmpl b/docs/template/dashboard.html.tmpl
@@ -0,0 +1,47 @@
+{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}
+{{!master(layout/_master.tmpl)}}
+<h1>{{title}}</h1>
+{{#items.Length}}
+<div id="template-container">
+{{#items}}
+  <div class="card">
+    <img src="{{thumbnail}}" class="card-img-top" alt="{{name}}">
+    <div class="card-body flex-fill">
+      <h5 class="card-title"><a href="{{homepage}}" class="card-link">{{name}}</a></h5>
+      <p class="card-text">{{{description}}}</p>
+    </div>
+    <div class="card-body flex-grow-0">
+      {{#usage}}
+      <div class="">
+        {{#config}}<div class="list-group-item"><c>docfx.json</c>: <code>{{config}}</code></div>{{/config}}
+        {{#command}}<div class="list-group-item"><c>docfx</c>: <code>{{command}}</code></div>{{/command}}
+        {{#init}}<div class="list-group-item"><c>docfx init</c>: <code>{{init}}</code></div>{{/init}}
+      </div>
+      {{/usage}}
+    </div>
+  </div>
+{{/items}}
+</div>
+{{/items.Length}}
+
+<style type="text/css">
+  .affix {
+    display: none !important;
+  }
+
+  .card {
+    width: 24rem;
+    margin: 1rem;
+  }
+
+  .card > img {
+    height: 16rem;
+    object-fit: cover;
+  }
+
+  #template-container {
+    display: flex;
+    flex-direction: row;
+    flex-wrap: wrap;
+  }
+</style>
diff --git a/docs/template/public/main.css b/docs/template/public/main.css
@@ -0,0 +1,10 @@
+/**
+ * Licensed to the .NET Foundation under one or more agreements.
+ * The .NET Foundation licenses this file to you under the MIT license.
+ */
+
+/* Checkout https://getbootstrap.com/docs/5.3/customize/color/ for more customization options */
+body {
+  --bs-link-color-rgb: 66, 184, 131 !important;
+  --bs-link-hover-color-rgb: 64, 180, 128 !important;
+}
diff --git a/docs/template/public/main.js b/docs/template/public/main.js
@@ -0,0 +1,14 @@
+/**
+ * Licensed to the .NET Foundation under one or more agreements.
+ * The .NET Foundation licenses this file to you under the MIT license.
+ */
+
+export default {
+  iconLinks: [
+    {
+      icon: 'github',
+      href: 'https://github.com/dotnet/docfx',
+      title: 'GitHub'
+    }
+  ]
+}
diff --git a/docs/template/schemas/Dashboard.schema.json b/docs/template/schemas/Dashboard.schema.json
@@ -0,0 +1,45 @@
+{
+    "title": "Dashboard",
+    "$schema": "https://dotnet.github.io/docfx/schemas/v1.0/schema.json#",
+    "version": "1.0.0",
+    "description": "Schema for dashboard",
+    "id": "https://github.com/dotnet/docfx/schemas/Dashboard.schema.json",
+    "type": "object",
+    "properties": {
+        "uid": {
+            "type": "string",
+            "contentType": "uid"
+        },
+        "title": {
+            "type": "string",
+            "tags": [
+                "localizable"
+            ]
+        },
+        "description": {
+            "type": "string",
+            "contentType": "markdown",
+            "tags": [
+                "localizable"
+            ]
+        },
+        "items": {
+            "items": {
+                "properties": {
+                    "name": {
+                        "type": "string"
+                    },
+                    "description": {
+                        "type": "string",
+                        "contentType": "markdown",
+                        "tags": [
+                            "localizable"
+                        ]
+                    }
+                },
+                "type": "object"
+            },
+            "type": "array"
+        }
+    }
+}
diff --git a/docs/toc.yml b/docs/toc.yml
@@ -0,0 +1,8 @@
+- name: Home
+  href: index.md
+- name: API Documentation
+  href: api/WebExpress.WebCore.html
+- name: User Guide
+  href: user-guide.md
+- name: Tutorials
+  href: tutorials.md
diff --git a/docs/tutorials.md b/docs/tutorials.md
@@ -0,0 +1,17 @@
+![WebExpress](https://raw.githubusercontent.com/ReneSchwarzer/WebExpress/main/assets/banner.png)
+
+# Tutorials
+Welcome to the `WebExpress` Tutorials! Here, you'll find step-by-step guides and helpful resources to get the most out 
+of `WebExpress`. Whether you're a beginner just starting out or an experienced developer looking to expand your skills, 
+our tutorials offer something for everyone.
+
+# Getting Started
+Begin with our basic tutorial:
+- [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)
+
+This tutorial will guide you through the initial steps of creating and running your first `WebExpress` application.
+
+Stay tuned for more exciting and educational tutorials to help you unlock the full potential of `WebExpress`. Happy coding and 
+best of luck with your projects!