Skip to content

Commit ee4e520

Browse files
mf366-devmf366-dev
committed
docs: Remove templating and add content
Also tried to fix API reference, but that ain't happening so soon.
1 parent b2851cc commit ee4e520

212 files changed

Lines changed: 22320 additions & 643 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/docs.yml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,11 @@ jobs:
3838
with:
3939
node-version: 24.x
4040

41-
#- name: Install DocFX
42-
# run: dotnet tool install -g docfx
41+
- name: Install DocFX
42+
run: dotnet tool install -g docfx
4343

44-
#- name: Generate assembly metadata
45-
# run: docfx metadata
44+
- name: Generate assembly metadata
45+
run: docfx metadata
4646

4747
- name: Install Docusaurus
4848
run: npm install

‎.vscode/launch.json‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
// Use IntelliSense to learn about possible attributes.
3+
// Hover to view descriptions of existing attributes.
4+
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
5+
"version": "0.2.0",
6+
"configurations": [
7+
{
8+
"name": "Python Debugger: Current File with Arguments",
9+
"type": "debugpy",
10+
"request": "launch",
11+
"program": "${file}",
12+
"console": "integratedTerminal",
13+
"args": "${command:pickArgs}"
14+
}
15+
]
16+
}

‎.vscode/settings.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"python.analysis.autoImportCompletions": true
3+
}

‎.vscode/tasks.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
// See https://go.microsoft.com/fwlink/?LinkId=733558
3+
// for the documentation about the tasks.json format
4+
"version": "2.0.0",
5+
"tasks": [
6+
{
7+
"label": "Generate API reference",
8+
"type": "shell",
9+
"command": "docfx metadata; py ./sanitize.py ./docs/api/net10.0/ ./api-categories/net10.0.json; py ./sanitize.py ./docs/api/net8.0/ ./api-categories/net8.0.json; py ./sanitize.py ./docs/api/net481/ ./api-categories/net481.json; py ./sanitize.py ./docs/api/net472/ ./api-categories/net472.json"
10+
}
11+
]
12+
}

‎README.md‎

Lines changed: 3 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,5 @@
1-
# Website
1+
# RSML Documentation
2+
> [!NOTE]
3+
> API reference is still a work in progress and currently looks completely unstructured because DocFX just dumps all the Markdown files in a single folder and Docusaurus does not know what to do with the `toc.yml` file.
24
35
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
4-
5-
## Installation
6-
7-
```bash
8-
npm install
9-
```
10-
11-
**Note**: feel free to use the package manager of your choice.
12-
13-
## Local Development
14-
15-
```bash
16-
npm run start
17-
```
18-
19-
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
20-
21-
## Build
22-
23-
```bash
24-
npm run build
25-
```
26-
27-
This command generates static content into the `build` directory and can be served using any static contents hosting service.
28-
29-
## Deployment
30-
31-
Using SSH:
32-
33-
```bash
34-
USE_SSH=true npm run deploy
35-
```
36-
37-
Not using SSH:
38-
39-
```bash
40-
GIT_USER=<Your GitHub username> npm run deploy
41-
```
42-
43-
If you are using GitHub Pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

‎api-categories/net10.0.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
"position": 1,
44
"link": {
55
"type": "generated-index",
6-
"description": "5 minutes to learn the most important Docusaurus concepts."
6+
"description": "RSML's .NET 10.0 API"
77
}
88
}

‎api-categories/net472.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
"position": 4,
44
"link": {
55
"type": "generated-index",
6-
"description": "5 minutes to learn the most important Docusaurus concepts."
6+
"description": "RSML's .NET Framework 4.7.2 API"
77
}
88
}

‎api-categories/net481.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
"position": 3,
44
"link": {
55
"type": "generated-index",
6-
"description": "5 minutes to learn the most important Docusaurus concepts."
6+
"description": "RSML's .NET Framework 4.8.1 API"
77
}
88
}

‎api-categories/net8.0.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
"position": 2,
44
"link": {
55
"type": "generated-index",
6-
"description": "5 minutes to learn the most important Docusaurus concepts."
6+
"description": "RSML's .NET 8.0 API"
77
}
88
}

‎docfx.json‎

Lines changed: 145 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,145 @@
1+
{
2+
"$schema": "https://raw.githubusercontent.com/dotnet/docfx/main/schemas/docfx.schema.json",
3+
"metadata": [
4+
{
5+
"src": [
6+
{
7+
"src": "rsml/src/",
8+
"files": [
9+
"**/*.csproj"
10+
]
11+
}
12+
],
13+
"properties": {
14+
"TargetFramework": "net10.0"
15+
},
16+
"output": "docs/api/net10.0",
17+
"useClrTypeNames": true,
18+
"outputFormat": "markdown",
19+
"memberLayout": "samePage",
20+
"namespaceLayout": "nested",
21+
"enumSortOrder": "declaringOrder",
22+
"globalNamespaceId": "OceanApocalypseStudios.RSML",
23+
"includeExplicitInterfaceImplementations": true
24+
},
25+
{
26+
"src": [
27+
{
28+
"src": "rsml/src/",
29+
"files": [
30+
"RSML/*.csproj",
31+
"RSML.Extensibility/*.csproj"
32+
]
33+
}
34+
],
35+
"properties": {
36+
"TargetFramework": "net8.0"
37+
},
38+
"output": "docs/api/net8.0",
39+
"useClrTypeNames": true,
40+
"outputFormat": "markdown",
41+
"memberLayout": "samePage",
42+
"namespaceLayout": "nested",
43+
"enumSortOrder": "declaringOrder",
44+
"globalNamespaceId": "OceanApocalypseStudios.RSML",
45+
"includeExplicitInterfaceImplementations": true
46+
},
47+
{
48+
"src": [
49+
{
50+
"src": "rsml/src/",
51+
"files": [
52+
"RSML/*.csproj",
53+
"RSML.Extensibility/*.csproj"
54+
]
55+
}
56+
],
57+
"properties": {
58+
"TargetFramework": "net481"
59+
},
60+
"output": "docs/api/net481",
61+
"useClrTypeNames": true,
62+
"outputFormat": "markdown",
63+
"memberLayout": "samePage",
64+
"namespaceLayout": "nested",
65+
"enumSortOrder": "declaringOrder",
66+
"globalNamespaceId": "OceanApocalypseStudios.RSML",
67+
"includeExplicitInterfaceImplementations": true
68+
},
69+
{
70+
"src": [
71+
{
72+
"src": "rsml/src/",
73+
"files": [
74+
"RSML/*.csproj",
75+
"RSML.Extensibility/*.csproj"
76+
]
77+
}
78+
],
79+
"properties": {
80+
"TargetFramework": "net472"
81+
},
82+
"output": "docs/api/net472",
83+
"useClrTypeNames": true,
84+
"outputFormat": "markdown",
85+
"memberLayout": "samePage",
86+
"namespaceLayout": "nested",
87+
"enumSortOrder": "declaringOrder",
88+
"globalNamespaceId": "OceanApocalypseStudios.RSML",
89+
"includeExplicitInterfaceImplementations": true
90+
}
91+
],
92+
"rules": {
93+
"InvalidHref": "error"
94+
},
95+
"build": {
96+
"content": [
97+
{
98+
"files": [
99+
"**/*.{md,yml}"
100+
],
101+
"exclude": [
102+
"__site/**"
103+
]
104+
}
105+
],
106+
"resource": [
107+
{
108+
"files": [
109+
"images/**",
110+
"articles/images/**"
111+
]
112+
}
113+
],
114+
"output": "__site",
115+
"template": [
116+
"default",
117+
"modern",
118+
"templates/override"
119+
],
120+
"globalMetadata": {
121+
"_appName": "Red Sea Markup Language",
122+
"_appTitle": "Red Sea Markup Language",
123+
"_appFaviconPath": "images/favicon.ico",
124+
"_appLogoPath": "images/xsmall.png",
125+
"_enableSearch": true,
126+
"pdf": true,
127+
"_enableNewTab": true,
128+
"_appFooter": "See on <a href=\"https://github.com/OceanApocalypseStudios/RedSeaMarkupLanguage/\">GitHub</a>.<br/>Docs made with <a href=\"https://dotnet.github.io/docfx/\">DocFX</a> and <a href=\"https://ovasquez.github.io/docfx-material/\">Material</a>.",
129+
"_copyrightFooter": "OceanApocalypseStudios. Documentation licensed under CC0 1.0."
130+
},
131+
"markdownEngineProperties": {
132+
"markdigExtensions": [
133+
"SmartyPants",
134+
"ListExtras",
135+
"Footnotes",
136+
"Footers",
137+
"Figures",
138+
"DefinitionLists"
139+
]
140+
},
141+
"postProcessors": [
142+
"ExtractSearchIndex"
143+
]
144+
}
145+
}

0 commit comments

Comments
 (0)