Skip to content

Commit c9344ad

Browse files
stratdev3stratdev3
committed
add new documentation site using vitepress
1 parent 475887d commit c9344ad

11 files changed

Lines changed: 2674 additions & 0 deletions

File tree

‎documentation/docs/.vitepress/config.mjs‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
import { defineConfig } from 'vitepress'
2+
3+
// https://vitepress.dev/reference/site-config
4+
export default defineConfig({
5+
title: "SimpleW",
6+
titleTemplate: 'SimpleW',
7+
description: "Simple Web server library in .NET Core",
8+
head: [
9+
['link', { rel: 'icon', href: '/favicon.ico' }]
10+
],
11+
themeConfig: {
12+
// https://vitepress.dev/reference/default-theme-config
13+
logo: '/logo.png',
14+
nav: [
15+
{ text: 'Guide', link: '/' },
16+
{
17+
text: 'v13.0.1',
18+
items: [
19+
{ text: 'Changelog', link: 'https://github.com/stratdev3/SimpleW/blob/master/release.md' },
20+
]
21+
},
22+
],
23+
24+
sidebar: [
25+
{
26+
text: 'Introduction',
27+
items: [
28+
{ text: 'What is SimpleW?', link: '/markdown-examples' },
29+
{ text: 'Getting Started', link: '/api-examples' },
30+
]
31+
},
32+
{
33+
text: 'Routes', link: '/markdown-examples',
34+
},
35+
{
36+
text: 'Serve Static Files', link: '/markdown-examples',
37+
},
38+
{
39+
text: 'Serve API REST',
40+
items: [
41+
{ text: 'Basic RestAPI Example', link: '/markdown-examples' },
42+
{ text: 'Return Data', link: '/markdown-examples' },
43+
{ text: 'Routing', link: '/markdown-examples' },
44+
{ text: 'Post Body', link: '/markdown-examples' },
45+
{ text: 'CORS', link: '/markdown-examples' },
46+
{ text: 'Serialization', link: '/markdown-examples' },
47+
{ text: 'Hooks', link: '/markdown-examples' },
48+
{ text: 'Properties', link: '/markdown-examples' },
49+
]
50+
},
51+
{
52+
text: 'Other Features',
53+
items: [
54+
{ text: 'JWT Authentication', link: '/markdown-examples' },
55+
{ text: 'Websockets', link: '/markdown-examples' },
56+
{ text: 'OpenTelemetry', link: '/markdown-examples' },
57+
{ text: 'Advanced', link: '/markdown-examples' },
58+
]
59+
},
60+
],
61+
62+
socialLinks: [
63+
{ icon: 'github', link: 'https://github.com/stratdev3/SimpleW' },
64+
//{ icon: 'nuget', link: 'https://www.nuget.org/packages/SimpleW' },
65+
],
66+
67+
footer: {
68+
message: 'Released under the MIT License.',
69+
copyright: 'Copyright © 2024-present StratDev'
70+
},
71+
72+
search: {
73+
provider: 'local'
74+
},
75+
},
76+
})

‎documentation/docs/.vitepress/theme/index.js‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
// https://vitepress.dev/guide/custom-theme
2+
import { h } from 'vue'
3+
import DefaultTheme from 'vitepress/theme'
4+
import './style.css'
5+
6+
/** @type {import('vitepress').Theme} */
7+
export default {
8+
extends: DefaultTheme,
9+
Layout: () => {
10+
return h(DefaultTheme.Layout, null, {
11+
// https://vitepress.dev/guide/extending-default-theme#layout-slots
12+
})
13+
},
14+
enhanceApp({ app, router, siteData }) {
15+
// ...
16+
}
17+
}

‎documentation/docs/.vitepress/theme/style.css‎

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
/**
2+
* Customize default theme styling by overriding CSS variables:
3+
* https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
4+
*/
5+
6+
/**
7+
* Colors
8+
*
9+
* Each colors have exact same color scale system with 3 levels of solid
10+
* colors with different brightness, and 1 soft color.
11+
*
12+
* - `XXX-1`: The most solid color used mainly for colored text. It must
13+
* satisfy the contrast ratio against when used on top of `XXX-soft`.
14+
*
15+
* - `XXX-2`: The color used mainly for hover state of the button.
16+
*
17+
* - `XXX-3`: The color for solid background, such as bg color of the button.
18+
* It must satisfy the contrast ratio with pure white (#ffffff) text on
19+
* top of it.
20+
*
21+
* - `XXX-soft`: The color used for subtle background such as custom container
22+
* or badges. It must satisfy the contrast ratio when putting `XXX-1` colors
23+
* on top of it.
24+
*
25+
* The soft color must be semi transparent alpha channel. This is crucial
26+
* because it allows adding multiple "soft" colors on top of each other
27+
* to create a accent, such as when having inline code block inside
28+
* custom containers.
29+
*
30+
* - `default`: The color used purely for subtle indication without any
31+
* special meanings attached to it such as bg color for menu hover state.
32+
*
33+
* - `brand`: Used for primary brand colors, such as link text, button with
34+
* brand theme, etc.
35+
*
36+
* - `tip`: Used to indicate useful information. The default theme uses the
37+
* brand color for this by default.
38+
*
39+
* - `warning`: Used to indicate warning to the users. Used in custom
40+
* container, badges, etc.
41+
*
42+
* - `danger`: Used to show error, or dangerous message to the users. Used
43+
* in custom container, badges, etc.
44+
* -------------------------------------------------------------------------- */
45+
46+
:root {
47+
--vp-c-default-1: var(--vp-c-gray-1);
48+
--vp-c-default-2: var(--vp-c-gray-2);
49+
--vp-c-default-3: var(--vp-c-gray-3);
50+
--vp-c-default-soft: var(--vp-c-gray-soft);
51+
52+
--vp-c-brand-1: var(--vp-c-indigo-1);
53+
--vp-c-brand-2: var(--vp-c-indigo-2);
54+
--vp-c-brand-3: var(--vp-c-indigo-3);
55+
--vp-c-brand-soft: var(--vp-c-indigo-soft);
56+
57+
--vp-c-tip-1: var(--vp-c-brand-1);
58+
--vp-c-tip-2: var(--vp-c-brand-2);
59+
--vp-c-tip-3: var(--vp-c-brand-3);
60+
--vp-c-tip-soft: var(--vp-c-brand-soft);
61+
62+
--vp-c-warning-1: var(--vp-c-yellow-1);
63+
--vp-c-warning-2: var(--vp-c-yellow-2);
64+
--vp-c-warning-3: var(--vp-c-yellow-3);
65+
--vp-c-warning-soft: var(--vp-c-yellow-soft);
66+
67+
--vp-c-danger-1: var(--vp-c-red-1);
68+
--vp-c-danger-2: var(--vp-c-red-2);
69+
--vp-c-danger-3: var(--vp-c-red-3);
70+
--vp-c-danger-soft: var(--vp-c-red-soft);
71+
}
72+
73+
/**
74+
* Component: Button
75+
* -------------------------------------------------------------------------- */
76+
77+
:root {
78+
--vp-button-brand-border: transparent;
79+
--vp-button-brand-text: var(--vp-c-white);
80+
--vp-button-brand-bg: var(--vp-c-brand-3);
81+
--vp-button-brand-hover-border: transparent;
82+
--vp-button-brand-hover-text: var(--vp-c-white);
83+
--vp-button-brand-hover-bg: var(--vp-c-brand-2);
84+
--vp-button-brand-active-border: transparent;
85+
--vp-button-brand-active-text: var(--vp-c-white);
86+
--vp-button-brand-active-bg: var(--vp-c-brand-1);
87+
}
88+
89+
/**
90+
* Component: Home
91+
* -------------------------------------------------------------------------- */
92+
93+
:root {
94+
--vp-home-hero-name-color: transparent;
95+
--vp-home-hero-name-background: -webkit-linear-gradient(
96+
120deg,
97+
#bd34fe 30%,
98+
#41d1ff
99+
);
100+
101+
--vp-home-hero-image-background-image: linear-gradient(
102+
-45deg,
103+
#bd34fe 50%,
104+
#47caff 50%
105+
);
106+
--vp-home-hero-image-filter: blur(44px);
107+
}
108+
109+
@media (min-width: 640px) {
110+
:root {
111+
--vp-home-hero-image-filter: blur(56px);
112+
}
113+
}
114+
115+
@media (min-width: 960px) {
116+
:root {
117+
--vp-home-hero-image-filter: blur(68px);
118+
}
119+
}
120+
121+
/**
122+
* Component: Custom Block
123+
* -------------------------------------------------------------------------- */
124+
125+
:root {
126+
--vp-custom-block-tip-border: transparent;
127+
--vp-custom-block-tip-text: var(--vp-c-text-1);
128+
--vp-custom-block-tip-bg: var(--vp-c-brand-soft);
129+
--vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
130+
}
131+
132+
/**
133+
* Component: Algolia
134+
* -------------------------------------------------------------------------- */
135+
136+
.DocSearch {
137+
--docsearch-primary-color: var(--vp-c-brand-1) !important;
138+
}
139+

‎documentation/docs/api-examples.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
outline: deep
3+
---
4+
5+
# Runtime API Examples
6+
7+
This page demonstrates usage of some of the runtime APIs provided by VitePress.
8+
9+
The main `useData()` API can be used to access site, theme, and page data for the current page. It works in both `.md` and `.vue` files:
10+
11+
```md
12+
<script setup>
13+
import { useData } from 'vitepress'
14+
15+
const { theme, page, frontmatter } = useData()
16+
</script>
17+
18+
## Results
19+
20+
### Theme Data
21+
<pre>{{ theme }}</pre>
22+
23+
### Page Data
24+
<pre>{{ page }}</pre>
25+
26+
### Page Frontmatter
27+
<pre>{{ frontmatter }}</pre>
28+
```
29+
30+
<script setup>
31+
import { useData } from 'vitepress'
32+
33+
const { site, theme, page, frontmatter } = useData()
34+
</script>
35+
36+
## Results
37+
38+
### Theme Data
39+
<pre>{{ theme }}</pre>
40+
41+
### Page Data
42+
<pre>{{ page }}</pre>
43+
44+
### Page Frontmatter
45+
<pre>{{ frontmatter }}</pre>
46+
47+
## More
48+
49+
Check out the documentation for the [full list of runtime APIs](https://vitepress.dev/reference/runtime-api#usedata).

‎documentation/docs/index.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
# https://vitepress.dev/reference/default-theme-home-page
3+
layout: home
4+
5+
hero:
6+
name: "SimpleW"
7+
text: "Web server Library .NET Core"
8+
#tagline: Simple, Fast and Featured
9+
#tagline: Designed for Simplicity. Built for Speed. Packed with Power.
10+
tagline: Powerfully Simple. Blazingly Fast.
11+
image:
12+
src: /logo.png
13+
alt: SimpleW
14+
actions:
15+
- theme: brand
16+
text: What is SimpleW?
17+
link: /markdown-examples
18+
- theme: alt
19+
text: Quick Start
20+
link: /api-examples
21+
- theme: alt
22+
text: GitHub
23+
link: https://github.com/stratdev3/SimpleW
24+
25+
features:
26+
- icon: 🚀
27+
title: Ultra-light & Blazing Fast
28+
details: Built on top of native sockets using NetCoreServer. Minimal overhead, instant startup, ideal for microservices, embedded apps, and high-performance workloads.
29+
- icon: 🛠️
30+
title: API REST
31+
details: Define routes and controllers without ceremony. Automatic JSON serialization. Focus on your business logic — no boilerplate, no mess.
32+
#- icon: 🔑
33+
# title: Json Web Token
34+
# details: Add token-based auth and real-time communication in minutes. Secure and scalable, without pulling in heavy frameworks.
35+
- icon: 🔐
36+
#icon: ⇄
37+
title: Built-in JWT & WebSocket
38+
details: Add token-based auth and real-time communication in minutes. Secure and scalable, without pulling in heavy frameworks.
39+
- icon: 🔬
40+
title: Observability
41+
details: Integrated OpenTelemetry with the support of distributed tracing and metrics collection. Easier to monitor, debug, and analyze requests.
42+
---

0 commit comments

Comments
 (0)