Skip to content

Commit 59a2ef7

Browse files
eliandoraneliandoran
committed
chore(build-docs): add preview entrypoint
1 parent 757a046 commit 59a2ef7

File tree

7 files changed

+261
-71
lines changed

7 files changed

+261
-71
lines changed

‎apps/server/src/assets/doc_notes/en/User Guide/!!!meta.json‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Safe mode.html‎

Lines changed: 5 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/Developer Guide/!!!meta.json‎

Lines changed: 49 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,13 @@
5656
"type": "text",
5757
"mime": "text/html",
5858
"attributes": [
59+
{
60+
"type": "relation",
61+
"name": "internalLink",
62+
"value": "TLXJwBDo8Rdv",
63+
"isInheritable": false,
64+
"position": 10
65+
},
5966
{
6067
"type": "label",
6168
"name": "iconClass",
@@ -69,13 +76,6 @@
6976
"value": "environment-setup",
7077
"isInheritable": false,
7178
"position": 20
72-
},
73-
{
74-
"type": "relation",
75-
"name": "internalLink",
76-
"value": "TLXJwBDo8Rdv",
77-
"isInheritable": false,
78-
"position": 30
7979
}
8080
],
8181
"format": "markdown",
@@ -96,6 +96,13 @@
9696
"type": "text",
9797
"mime": "text/html",
9898
"attributes": [
99+
{
100+
"type": "relation",
101+
"name": "internalLink",
102+
"value": "a0mkxxB4Uvbf",
103+
"isInheritable": false,
104+
"position": 10
105+
},
99106
{
100107
"type": "label",
101108
"name": "iconClass",
@@ -109,13 +116,6 @@
109116
"value": "project-structure",
110117
"isInheritable": false,
111118
"position": 20
112-
},
113-
{
114-
"type": "relation",
115-
"name": "internalLink",
116-
"value": "a0mkxxB4Uvbf",
117-
"isInheritable": false,
118-
"position": 30
119119
}
120120
],
121121
"format": "markdown",
@@ -246,25 +246,25 @@
246246
"mime": "text/html",
247247
"attributes": [
248248
{
249-
"type": "label",
250-
"name": "shareAlias",
251-
"value": "dev-build",
249+
"type": "relation",
250+
"name": "internalLink",
251+
"value": "mXFYlhuEr1mZ",
252252
"isInheritable": false,
253-
"position": 20
253+
"position": 10
254254
},
255255
{
256256
"type": "relation",
257257
"name": "internalLink",
258258
"value": "T2W7WCZrYZBU",
259259
"isInheritable": false,
260-
"position": 30
260+
"position": 20
261261
},
262262
{
263-
"type": "relation",
264-
"name": "internalLink",
265-
"value": "mXFYlhuEr1mZ",
263+
"type": "label",
264+
"name": "shareAlias",
265+
"value": "dev-build",
266266
"isInheritable": false,
267-
"position": 40
267+
"position": 20
268268
}
269269
],
270270
"format": "markdown",
@@ -736,14 +736,14 @@
736736
"name": "internalLink",
737737
"value": "DSkl8C325tEC",
738738
"isInheritable": false,
739-
"position": 20
739+
"position": 10
740740
},
741741
{
742742
"type": "relation",
743743
"name": "internalLink",
744744
"value": "tM3rIZQzlum4",
745745
"isInheritable": false,
746-
"position": 30
746+
"position": 20
747747
},
748748
{
749749
"type": "label",
@@ -1082,16 +1082,16 @@
10821082
"mime": "text/html",
10831083
"attributes": [
10841084
{
1085-
"type": "label",
1086-
"name": "iconClass",
1087-
"value": "bx bx-table",
1085+
"type": "relation",
1086+
"name": "internalLink",
1087+
"value": "DSkl8C325tEC",
10881088
"isInheritable": false,
10891089
"position": 10
10901090
},
10911091
{
10921092
"type": "relation",
10931093
"name": "internalLink",
1094-
"value": "DSkl8C325tEC",
1094+
"value": "VIcWnKGs0sMh",
10951095
"isInheritable": false,
10961096
"position": 20
10971097
},
@@ -1103,11 +1103,11 @@
11031103
"position": 30
11041104
},
11051105
{
1106-
"type": "relation",
1107-
"name": "internalLink",
1108-
"value": "VIcWnKGs0sMh",
1106+
"type": "label",
1107+
"name": "iconClass",
1108+
"value": "bx bx-table",
11091109
"isInheritable": false,
1110-
"position": 40
1110+
"position": 10
11111111
},
11121112
{
11131113
"type": "label",
@@ -1243,14 +1243,14 @@
12431243
{
12441244
"type": "relation",
12451245
"name": "internalLink",
1246-
"value": "PXzm2t3sCdsP",
1246+
"value": "oLhKpfi2kGON",
12471247
"isInheritable": false,
12481248
"position": 10
12491249
},
12501250
{
12511251
"type": "relation",
12521252
"name": "internalLink",
1253-
"value": "oLhKpfi2kGON",
1253+
"value": "PXzm2t3sCdsP",
12541254
"isInheritable": false,
12551255
"position": 20
12561256
},
@@ -1877,18 +1877,18 @@
18771877
"mime": "text/html",
18781878
"attributes": [
18791879
{
1880-
"type": "label",
1881-
"name": "shareAlias",
1882-
"value": "printing",
1880+
"type": "relation",
1881+
"name": "internalLink",
1882+
"value": "k7RavjuXQt8z",
18831883
"isInheritable": false,
18841884
"position": 20
18851885
},
18861886
{
1887-
"type": "relation",
1888-
"name": "internalLink",
1889-
"value": "k7RavjuXQt8z",
1887+
"type": "label",
1888+
"name": "shareAlias",
1889+
"value": "printing",
18901890
"isInheritable": false,
1891-
"position": 40
1891+
"position": 20
18921892
},
18931893
{
18941894
"type": "label",
@@ -2228,6 +2228,13 @@
22282228
"type": "text",
22292229
"mime": "text/html",
22302230
"attributes": [
2231+
{
2232+
"type": "relation",
2233+
"name": "internalLink",
2234+
"value": "IxkDdjTogO18",
2235+
"isInheritable": false,
2236+
"position": 10
2237+
},
22312238
{
22322239
"type": "label",
22332240
"name": "shareAlias",

‎docs/Developer Guide/Developer Guide/Building/Documentation.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,7 @@ The `deploy-docs` workflow triggers the documentation build and uploads it to Cl
1414

1515
## Building locally
1616

17-
In the Git root, run `pnpm docs:build`. The built documentation will be available in `site` at Git root.
17+
In the Git root:
18+
19+
* Run `pnpm docs:build`. The built documentation will be available in `site` at Git root.
20+
* To also run a webserver to test it, run `pnpm docs:preview` (this will not build the documentation) and navigate to `localhost:9000`.

‎docs/User Guide/!!!meta.json‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1166,6 +1166,22 @@
11661166
"dataFileName": "Multi-Factor Authentication.md",
11671167
"attachments": []
11681168
},
1169+
{
1170+
"isClone": true,
1171+
"noteId": "Un4wj2Mak2Ky",
1172+
"notePath": [
1173+
"pOsGYCXsbNQG",
1174+
"Otzi9La2YAUX",
1175+
"WOcw2SLH6tbX",
1176+
"Un4wj2Mak2Ky"
1177+
],
1178+
"title": "Nix flake",
1179+
"prefix": null,
1180+
"dataFileName": "Nix flake.clone.md",
1181+
"type": "text",
1182+
"format": "markdown",
1183+
"isExpanded": false
1184+
},
11691185
{
11701186
"isClone": false,
11711187
"noteId": "yeEaYqosGLSh",
@@ -1256,22 +1272,6 @@
12561272
"format": "markdown",
12571273
"dataFileName": "System Requirements.md",
12581274
"attachments": []
1259-
},
1260-
{
1261-
"isClone": true,
1262-
"noteId": "Un4wj2Mak2Ky",
1263-
"notePath": [
1264-
"pOsGYCXsbNQG",
1265-
"Otzi9La2YAUX",
1266-
"WOcw2SLH6tbX",
1267-
"Un4wj2Mak2Ky"
1268-
],
1269-
"title": "Nix flake",
1270-
"prefix": null,
1271-
"dataFileName": "Nix flake.clone.md",
1272-
"type": "text",
1273-
"format": "markdown",
1274-
"isExpanded": false
12751275
}
12761276
]
12771277
},

‎package.json‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
"chore:update-build-info": "tsx ./scripts/update-build-info.ts",
2828
"chore:update-version": "tsx ./scripts/update-version.ts",
2929
"docs:build": "pnpm run --filter build-docs start",
30+
"docs:preview": "pnpm http-server site -p 9000",
3031
"edit-docs:edit-docs": "pnpm run --filter edit-docs edit-docs",
3132
"edit-docs:edit-demo": "pnpm run --filter edit-docs edit-demo",
3233
"test:all": "pnpm test:parallel && pnpm test:sequential",
@@ -54,6 +55,7 @@
5455
"eslint-plugin-playwright": "2.3.0",
5556
"eslint-plugin-react-hooks": "7.0.1",
5657
"happy-dom": "~20.0.0",
58+
"http-server": "14.1.1",
5759
"jiti": "2.6.1",
5860
"jsonc-eslint-parser": "2.4.1",
5961
"react-refresh": "0.18.0",

0 commit comments

Comments
 (0)