Skip to content

Commit 8de417c

Browse files
ReneSchwarzerReneSchwarzer
authored
Merge pull request #8 from ReneSchwarzer/develop
Version 0.0.8
2 parents 8007606 + c207bdd commit 8de417c

602 files changed

Lines changed: 26624 additions & 8083 deletions

File tree

Some content is hidden

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

‎.github/workflows/generate-docs.yml‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: Generate and Deploy Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
permissions:
9+
actions: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: "pages"
15+
cancel-in-progress: false
16+
17+
jobs:
18+
publish-docs:
19+
environment:
20+
name: github-pages
21+
url: ${{ steps.deployment.outputs.page_url }}
22+
runs-on: ubuntu-latest
23+
24+
steps:
25+
- name: Checkout code
26+
uses: actions/checkout@v3
27+
28+
- name: Setup .NET SDK
29+
uses: actions/setup-dotnet@v3
30+
with:
31+
dotnet-version: 9.x
32+
33+
- name: Install DocFX
34+
run: dotnet tool install -g docfx
35+
36+
- name: Add DocFX to PATH
37+
run: echo "$HOME/.dotnet/tools" >> $GITHUB_PATH
38+
39+
- name: Generate documentation
40+
run: |
41+
cd docs
42+
docfx metadata
43+
docfx build
44+
45+
- name: Upload artifact
46+
uses: actions/upload-pages-artifact@v3
47+
with:
48+
path: '_site'
49+
50+
- name: Deploy to GitHub Pages
51+
id: deployment
52+
uses: actions/deploy-pages@v4

‎README.md‎

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,43 @@
11
![WebExpress](https://raw.githubusercontent.com/ReneSchwarzer/WebExpress/main/assets/banner.png)
22

33
# WebExpress
4-
WebExpress is a lightweight web server optimized for use in low-performance environments (e.g. Rasperry PI). By providing
5-
a powerful plugin system and a comprehensive API, web applications can be easily and quickly integrated into a .net
6-
language (e.g. C#). Some advantages of WebExpress are:
4+
`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:
75

86
- It is easy to use.
97
- It offers a variety of features and tools that can help you build and manage your website.
108
- It is fast and efficient and can help you save time and money.
119
- It is flexible and can be customized to meet your specific requirements.
1210

13-
The WebExpress family includes the following projects:
11+
The `WebExpress` family includes the following projects:
1412

15-
- [WebExpress](https://github.com/ReneSchwarzer/WebExpress#readme) - The web server for WebExpress applications and the documentation.
16-
- [WebExpress.WebCore](https://github.com/ReneSchwarzer/WebExpress.WebCore#readme) - The core for WebExpress applications.
17-
- [WebExpress.WebUI](https://github.com/ReneSchwarzer/WebExpress.WebUI#readme) - Common templates and controls for WebExpress applications.
18-
- [WebExpress.WebIndex](https://github.com/ReneSchwarzer/WebExpress.WebIndex#readme) - Reverse index for WebExpress applications.
19-
- [WebExpress.WebApp](https://github.com/ReneSchwarzer/WebExpress.WebApp#readme) - Business application template for WebExpress applications.
13+
- [WebExpress](https://github.com/ReneSchwarzer/WebExpress#readme) - The web server for `WebExpress` applications and the documentation.
14+
- [WebExpress.WebCore](https://github.com/ReneSchwarzer/WebExpress.WebCore#readme) - The core for `WebExpress` applications.
15+
- [WebExpress.WebUI](https://github.com/ReneSchwarzer/WebExpress.WebUI#readme) - Common templates and controls for `WebExpress` applications.
16+
- [WebExpress.WebIndex](https://github.com/ReneSchwarzer/WebExpress.WebIndex#readme) - Reverse index for `WebExpress` applications.
17+
- [WebExpress.WebApp](https://github.com/ReneSchwarzer/WebExpress.WebApp#readme) - Business application template for `WebExpress` applications.
2018

2119
# WebExpress.WebCore
22-
WebCore is part of the Webexpres family and includes the basic elements of a WebExpress application.
20+
`WebCore` is part of the `WebExpress` family and includes the basic elements of a `WebExpress` application.
2321

2422
# Download
2523
The current binaries are available for download [here](https://github.com/ReneSchwarzer/WebExpress/releases).
2624

2725
# Start
28-
To get started with WebExpress, use the following links and tutorials.
26+
If you're looking to get started with `WebExpress`, we would recommend using the following documentation. It can help you understand the platform.
2927

30-
- [installation guide](https://github.com/ReneSchwarzer/WebExpress/blob/main/doc/installation_guide.md)
31-
- [development guide](https://github.com/ReneSchwarzer/WebExpress/blob/main/doc/development_guide.md)
28+
- [Installation Guide](https://github.com/ReneSchwarzer/WebExpress/blob/main/doc/installation_guide.md)
29+
- [Development Guide](https://github.com/ReneSchwarzer/WebExpress/blob/main/doc/development_guide.md)
30+
- [WebExpress.WebCore API Documentation](https://reneschwarzer.github.io/WebExpress.WebCore/)
31+
- [WebExpress.WebUI API Documentation](https://reneschwarzer.github.io/WebExpress.WebUI/)
32+
- [WebExpress.WebApp API Documentation](https://reneschwarzer.github.io/WebExpress.WebApp/)
33+
- [WebExpress.WebIndex API Documentation](https://reneschwarzer.github.io/WebExpress.WebIndex/)
34+
35+
# Learning
36+
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.
3237

33-
## Tutorials
3438
- [HelloWorld](https://github.com/ReneSchwarzer/WebExpress.Tutorial.HelloWorld#readme)
39+
- [WebApp](https://github.com/ReneSchwarzer/WebExpress.Tutorial.WebApp#readme)
40+
- [WebIndex](https://github.com/ReneSchwarzer/WebExpress.Tutorial.WebIndex#readme)
3541

3642
# Tags
37-
#Raspberry #Raspbian #IoT #NETCore #WebExpress
43+
#WebCore #WebExpress #DotNet #NETCore

‎docs/api/toc.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
### YamlMime:TableOfContent
2+
[]

‎docs/assets/webexpress.ico‎

68.5 KB
Binary file not shown.

‎docs/assets/webexpress.svg‎

Lines changed: 40 additions & 0 deletions
Loading

‎docs/docfx.json‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
{
2+
"$schema": "https://raw.githubusercontent.com/dotnet/docfx/main/schemas/docfx.schema.json",
3+
"metadata": [
4+
{
5+
"src": [
6+
{
7+
"files": [
8+
"src/WebExpress.WebCore/*.csproj"
9+
],
10+
"src": "../"
11+
}
12+
],
13+
"dest": "api",
14+
"outputFormat": "apiPage"
15+
}
16+
],
17+
"build": {
18+
"content": [
19+
{
20+
"files": [ "**/*.{md,yml}" ],
21+
"exclude": [ "_site/**", "obj/**" ]
22+
}
23+
],
24+
"resource": [
25+
{
26+
"files": [ "**/images/**", "**/media/**", "codesnippet/**" ],
27+
"exclude": [ "_site/**", "obj/**" ]
28+
},
29+
{
30+
"files": [ "assets/webexpress.ico", "assets/webexpress.svg" ]
31+
},
32+
{
33+
"src": "../schemas",
34+
"files": [ "**/*.json" ],
35+
"dest": "schemas"
36+
}
37+
],
38+
"postProcessors": [ "ExtractSearchIndex" ],
39+
"globalMetadata": {
40+
"_appTitle": "WebExpress.WebCore",
41+
"_appName": "WebExpress.WebCore",
42+
"_appFaviconPath": "assets/webexpress.ico",
43+
"_appLogoPath": "assets/webexpress.svg",
44+
"pdf": false
45+
},
46+
"markdownEngineProperties": {
47+
"alerts": {
48+
"TODO": "alert alert-secondary"
49+
}
50+
},
51+
"xref": [
52+
"../.xrefmap.json"
53+
],
54+
"output": "../_site",
55+
"template": [
56+
"default",
57+
"modern",
58+
"template"
59+
]
60+
}
61+
}

‎docs/index.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
![WebExpress](https://raw.githubusercontent.com/ReneSchwarzer/WebExpress/main/assets/banner.png)
2+
3+
# WebExpress
4+
WebExpress is a lightweight web server optimized for use in low-performance environments (e.g. Raspberry PI). By providing
5+
a powerful plugin system and a comprehensive API, web applications can be easily and quickly integrated into a .NET
6+
language (e.g. C#). Some advantages of WebExpress are:
7+
8+
- It is easy to use.
9+
- It offers a variety of features and tools that can help you build and manage your website.
10+
- It is fast and efficient and can help you save time and money.
11+
- It is flexible and can be customized to meet your specific requirements.
12+
13+
The `WebExpress` family includes the following projects:
14+
15+
- [WebExpress](https://github.com/ReneSchwarzer/WebExpress#readme) - The web server for `WebExpress` applications and the documentation.
16+
- [WebExpress.WebCore](https://github.com/ReneSchwarzer/WebExpress.WebCore#readme) - The core for `WebExpress` applications.
17+
- [WebExpress.WebUI](https://github.com/ReneSchwarzer/WebExpress.WebUI#readme) - Common templates and controls for `WebExpress` applications.
18+
- [WebExpress.WebIndex](https://github.com/ReneSchwarzer/WebExpress.WebIndex#readme) - Reverse index for `WebExpress` applications.
19+
- [WebExpress.WebApp](https://github.com/ReneSchwarzer/WebExpress.WebApp#readme) - Business application template for `WebExpress` applications.
20+
21+
# WebExpress.WebCore
22+
WebCore is part of the WebExpress family and includes the basic elements of a WebExpress application.
23+
24+
# Download
25+
The current binaries are available for download [here](https://github.com/ReneSchwarzer/WebExpress/releases).
26+
27+
# Tags
28+
#Raspberry #Raspbian #IoT #NETCore #WebExpress

‎docs/template/dashboard.html.tmpl‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}
2+
{{!master(layout/_master.tmpl)}}
3+
<h1>{{title}}</h1>
4+
{{#items.Length}}
5+
<div id="template-container">
6+
{{#items}}
7+
<div class="card">
8+
<img src="{{thumbnail}}" class="card-img-top" alt="{{name}}">
9+
<div class="card-body flex-fill">
10+
<h5 class="card-title"><a href="{{homepage}}" class="card-link">{{name}}</a></h5>
11+
<p class="card-text">{{{description}}}</p>
12+
</div>
13+
<div class="card-body flex-grow-0">
14+
{{#usage}}
15+
<div class="">
16+
{{#config}}<div class="list-group-item"><c>docfx.json</c>: <code>{{config}}</code></div>{{/config}}
17+
{{#command}}<div class="list-group-item"><c>docfx</c>: <code>{{command}}</code></div>{{/command}}
18+
{{#init}}<div class="list-group-item"><c>docfx init</c>: <code>{{init}}</code></div>{{/init}}
19+
</div>
20+
{{/usage}}
21+
</div>
22+
</div>
23+
{{/items}}
24+
</div>
25+
{{/items.Length}}
26+
27+
<style type="text/css">
28+
.affix {
29+
display: none !important;
30+
}
31+
32+
.card {
33+
width: 24rem;
34+
margin: 1rem;
35+
}
36+
37+
.card > img {
38+
height: 16rem;
39+
object-fit: cover;
40+
}
41+
42+
#template-container {
43+
display: flex;
44+
flex-direction: row;
45+
flex-wrap: wrap;
46+
}
47+
</style>

‎docs/template/public/main.css‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
/**
2+
* Licensed to the .NET Foundation under one or more agreements.
3+
* The .NET Foundation licenses this file to you under the MIT license.
4+
*/
5+
6+
/* Checkout https://getbootstrap.com/docs/5.3/customize/color/ for more customization options */
7+
body {
8+
--bs-link-color-rgb: 66, 184, 131 !important;
9+
--bs-link-hover-color-rgb: 64, 180, 128 !important;
10+
}

‎docs/template/public/main.js‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
/**
2+
* Licensed to the .NET Foundation under one or more agreements.
3+
* The .NET Foundation licenses this file to you under the MIT license.
4+
*/
5+
6+
export default {
7+
iconLinks: [
8+
{
9+
icon: 'github',
10+
href: 'https://github.com/dotnet/docfx',
11+
title: 'GitHub'
12+
}
13+
]
14+
}

0 commit comments

Comments
 (0)