Skip to content

Commit 26a0e07

Browse files
06kellyjac06kellyjac
committed
chore: correct mdx changes to avoid breaking the build
1 parent f02b569 commit 26a0e07

File tree

2 files changed

+31
-59
lines changed

2 files changed

+31
-59
lines changed

‎scripts/doc-schema.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ try {
2020
console.log(genDocOutput);
2121

2222
const schemaDoc = readFileSync(`${tempdir}${sep}schema.md`, 'utf-8')
23+
.replace(/\s\s\n\n<\/summary>/g, '\n</summary>')
2324
.replace(/# GitProxy configuration file/g, '# Schema Reference'); // https://github.com/finos/git-proxy/pull/327#discussion_r1377343213
2425
const docString = `---
2526
title: Schema Reference

‎website/docs/configuration/reference.mdx

Lines changed: 30 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,7 @@ description: JSON schema reference documentation for GitProxy
1717

1818
<details>
1919
<summary>
20-
<strong> <a name="proxyUrl"></a>1. [Optional] Property GitProxy configuration file > proxyUrl</strong>
21-
20+
<strong> <a name="proxyUrl"></a>1. [Optional] Property GitProxy configuration file > proxyUrl</strong>
2221
</summary>
2322
<blockquote>
2423

@@ -32,8 +31,7 @@ description: JSON schema reference documentation for GitProxy
3231

3332
<details>
3433
<summary>
35-
<strong> <a name="cookieSecret"></a>2. [Optional] Property GitProxy configuration file > cookieSecret</strong>
36-
34+
<strong> <a name="cookieSecret"></a>2. [Optional] Property GitProxy configuration file > cookieSecret</strong>
3735
</summary>
3836
<blockquote>
3937

@@ -47,8 +45,7 @@ description: JSON schema reference documentation for GitProxy
4745

4846
<details>
4947
<summary>
50-
<strong> <a name="sessionMaxAgeHours"></a>3. [Optional] Property GitProxy configuration file > sessionMaxAgeHours</strong>
51-
48+
<strong> <a name="sessionMaxAgeHours"></a>3. [Optional] Property GitProxy configuration file > sessionMaxAgeHours</strong>
5249
</summary>
5350
<blockquote>
5451

@@ -62,8 +59,7 @@ description: JSON schema reference documentation for GitProxy
6259

6360
<details>
6461
<summary>
65-
<strong> <a name="api"></a>4. [Optional] Property GitProxy configuration file > api</strong>
66-
62+
<strong> <a name="api"></a>4. [Optional] Property GitProxy configuration file > api</strong>
6763
</summary>
6864
<blockquote>
6965

@@ -80,8 +76,7 @@ description: JSON schema reference documentation for GitProxy
8076

8177
<details>
8278
<summary>
83-
<strong> <a name="commitConfig"></a>5. [Optional] Property GitProxy configuration file > commitConfig</strong>
84-
79+
<strong> <a name="commitConfig"></a>5. [Optional] Property GitProxy configuration file > commitConfig</strong>
8580
</summary>
8681
<blockquote>
8782

@@ -98,8 +93,7 @@ description: JSON schema reference documentation for GitProxy
9893

9994
<details>
10095
<summary>
101-
<strong> <a name="attestationConfig"></a>6. [Optional] Property GitProxy configuration file > attestationConfig</strong>
102-
96+
<strong> <a name="attestationConfig"></a>6. [Optional] Property GitProxy configuration file > attestationConfig</strong>
10397
</summary>
10498
<blockquote>
10599

@@ -116,8 +110,7 @@ description: JSON schema reference documentation for GitProxy
116110

117111
<details>
118112
<summary>
119-
<strong> <a name="domains"></a>7. [Optional] Property GitProxy configuration file > domains</strong>
120-
113+
<strong> <a name="domains"></a>7. [Optional] Property GitProxy configuration file > domains</strong>
121114
</summary>
122115
<blockquote>
123116

@@ -134,8 +127,7 @@ description: JSON schema reference documentation for GitProxy
134127

135128
<details>
136129
<summary>
137-
<strong> <a name="privateOrganizations"></a>8. [Optional] Property GitProxy configuration file > privateOrganizations</strong>
138-
130+
<strong> <a name="privateOrganizations"></a>8. [Optional] Property GitProxy configuration file > privateOrganizations</strong>
139131
</summary>
140132
<blockquote>
141133

@@ -151,8 +143,7 @@ description: JSON schema reference documentation for GitProxy
151143

152144
<details>
153145
<summary>
154-
<strong> <a name="urlShortener"></a>9. [Optional] Property GitProxy configuration file > urlShortener</strong>
155-
146+
<strong> <a name="urlShortener"></a>9. [Optional] Property GitProxy configuration file > urlShortener</strong>
156147
</summary>
157148
<blockquote>
158149

@@ -168,8 +159,7 @@ description: JSON schema reference documentation for GitProxy
168159

169160
<details>
170161
<summary>
171-
<strong> <a name="contactEmail"></a>10. [Optional] Property GitProxy configuration file > contactEmail</strong>
172-
162+
<strong> <a name="contactEmail"></a>10. [Optional] Property GitProxy configuration file > contactEmail</strong>
173163
</summary>
174164
<blockquote>
175165

@@ -185,8 +175,7 @@ description: JSON schema reference documentation for GitProxy
185175

186176
<details>
187177
<summary>
188-
<strong> <a name="csrfProtection"></a>11. [Optional] Property GitProxy configuration file > csrfProtection</strong>
189-
178+
<strong> <a name="csrfProtection"></a>11. [Optional] Property GitProxy configuration file > csrfProtection</strong>
190179
</summary>
191180
<blockquote>
192181

@@ -202,8 +191,7 @@ description: JSON schema reference documentation for GitProxy
202191

203192
<details>
204193
<summary>
205-
<strong> <a name="plugins"></a>12. [Optional] Property GitProxy configuration file > plugins</strong>
206-
194+
<strong> <a name="plugins"></a>12. [Optional] Property GitProxy configuration file > plugins</strong>
207195
</summary>
208196
<blockquote>
209197

@@ -230,8 +218,7 @@ description: JSON schema reference documentation for GitProxy
230218

231219
<details>
232220
<summary>
233-
<strong> <a name="authorisedList"></a>13. [Optional] Property GitProxy configuration file > authorisedList</strong>
234-
221+
<strong> <a name="authorisedList"></a>13. [Optional] Property GitProxy configuration file > authorisedList</strong>
235222
</summary>
236223
<blockquote>
237224

@@ -257,8 +244,7 @@ description: JSON schema reference documentation for GitProxy
257244

258245
<details>
259246
<summary>
260-
<strong> <a name="authorisedList_items_project"></a>13.1.1. [Required] Property GitProxy configuration file > authorisedList > authorisedList items > project</strong>
261-
247+
<strong> <a name="authorisedList_items_project"></a>13.1.1. [Required] Property GitProxy configuration file > authorisedList > authorisedList items > project</strong>
262248
</summary>
263249
<blockquote>
264250

@@ -272,8 +258,7 @@ description: JSON schema reference documentation for GitProxy
272258

273259
<details>
274260
<summary>
275-
<strong> <a name="authorisedList_items_name"></a>13.1.2. [Required] Property GitProxy configuration file > authorisedList > authorisedList items > name</strong>
276-
261+
<strong> <a name="authorisedList_items_name"></a>13.1.2. [Required] Property GitProxy configuration file > authorisedList > authorisedList items > name</strong>
277262
</summary>
278263
<blockquote>
279264

@@ -287,8 +272,7 @@ description: JSON schema reference documentation for GitProxy
287272

288273
<details>
289274
<summary>
290-
<strong> <a name="authorisedList_items_url"></a>13.1.3. [Required] Property GitProxy configuration file > authorisedList > authorisedList items > url</strong>
291-
275+
<strong> <a name="authorisedList_items_url"></a>13.1.3. [Required] Property GitProxy configuration file > authorisedList > authorisedList items > url</strong>
292276
</summary>
293277
<blockquote>
294278

@@ -305,8 +289,7 @@ description: JSON schema reference documentation for GitProxy
305289

306290
<details>
307291
<summary>
308-
<strong> <a name="sink"></a>14. [Optional] Property GitProxy configuration file > sink</strong>
309-
292+
<strong> <a name="sink"></a>14. [Optional] Property GitProxy configuration file > sink</strong>
310293
</summary>
311294
<blockquote>
312295

@@ -332,8 +315,7 @@ description: JSON schema reference documentation for GitProxy
332315

333316
<details>
334317
<summary>
335-
<strong> <a name="sink_items_type"></a>14.1.1. [Required] Property GitProxy configuration file > sink > sink items > type</strong>
336-
318+
<strong> <a name="sink_items_type"></a>14.1.1. [Required] Property GitProxy configuration file > sink > sink items > type</strong>
337319
</summary>
338320
<blockquote>
339321

@@ -347,8 +329,7 @@ description: JSON schema reference documentation for GitProxy
347329

348330
<details>
349331
<summary>
350-
<strong> <a name="sink_items_enabled"></a>14.1.2. [Required] Property GitProxy configuration file > sink > sink items > enabled</strong>
351-
332+
<strong> <a name="sink_items_enabled"></a>14.1.2. [Required] Property GitProxy configuration file > sink > sink items > enabled</strong>
352333
</summary>
353334
<blockquote>
354335

@@ -362,8 +343,7 @@ description: JSON schema reference documentation for GitProxy
362343

363344
<details>
364345
<summary>
365-
<strong> <a name="sink_items_connectionString"></a>14.1.3. [Optional] Property GitProxy configuration file > sink > sink items > connectionString</strong>
366-
346+
<strong> <a name="sink_items_connectionString"></a>14.1.3. [Optional] Property GitProxy configuration file > sink > sink items > connectionString</strong>
367347
</summary>
368348
<blockquote>
369349

@@ -377,8 +357,7 @@ description: JSON schema reference documentation for GitProxy
377357

378358
<details>
379359
<summary>
380-
<strong> <a name="sink_items_options"></a>14.1.4. [Optional] Property GitProxy configuration file > sink > sink items > options</strong>
381-
360+
<strong> <a name="sink_items_options"></a>14.1.4. [Optional] Property GitProxy configuration file > sink > sink items > options</strong>
382361
</summary>
383362
<blockquote>
384363

@@ -393,8 +372,7 @@ description: JSON schema reference documentation for GitProxy
393372

394373
<details>
395374
<summary>
396-
<strong> <a name="sink_items_params"></a>14.1.5. [Optional] Property GitProxy configuration file > sink > sink items > params</strong>
397-
375+
<strong> <a name="sink_items_params"></a>14.1.5. [Optional] Property GitProxy configuration file > sink > sink items > params</strong>
398376
</summary>
399377
<blockquote>
400378

@@ -412,8 +390,7 @@ description: JSON schema reference documentation for GitProxy
412390

413391
<details>
414392
<summary>
415-
<strong> <a name="authentication"></a>15. [Optional] Property GitProxy configuration file > authentication</strong>
416-
393+
<strong> <a name="authentication"></a>15. [Optional] Property GitProxy configuration file > authentication</strong>
417394
</summary>
418395
<blockquote>
419396

@@ -439,8 +416,7 @@ description: JSON schema reference documentation for GitProxy
439416

440417
<details>
441418
<summary>
442-
<strong> <a name="authentication_items_type"></a>15.1.1. [Required] Property GitProxy configuration file > authentication > authentication items > type</strong>
443-
419+
<strong> <a name="authentication_items_type"></a>15.1.1. [Required] Property GitProxy configuration file > authentication > authentication items > type</strong>
444420
</summary>
445421
<blockquote>
446422

@@ -454,8 +430,7 @@ description: JSON schema reference documentation for GitProxy
454430

455431
<details>
456432
<summary>
457-
<strong> <a name="authentication_items_enabled"></a>15.1.2. [Required] Property GitProxy configuration file > authentication > authentication items > enabled</strong>
458-
433+
<strong> <a name="authentication_items_enabled"></a>15.1.2. [Required] Property GitProxy configuration file > authentication > authentication items > enabled</strong>
459434
</summary>
460435
<blockquote>
461436

@@ -469,8 +444,7 @@ description: JSON schema reference documentation for GitProxy
469444

470445
<details>
471446
<summary>
472-
<strong> <a name="authentication_items_options"></a>15.1.3. [Optional] Property GitProxy configuration file > authentication > authentication items > options</strong>
473-
447+
<strong> <a name="authentication_items_options"></a>15.1.3. [Optional] Property GitProxy configuration file > authentication > authentication items > options</strong>
474448
</summary>
475449
<blockquote>
476450

@@ -488,8 +462,7 @@ description: JSON schema reference documentation for GitProxy
488462

489463
<details>
490464
<summary>
491-
<strong> <a name="tempPassword"></a>16. [Optional] Property GitProxy configuration file > tempPassword</strong>
492-
465+
<strong> <a name="tempPassword"></a>16. [Optional] Property GitProxy configuration file > tempPassword</strong>
493466
</summary>
494467
<blockquote>
495468

@@ -503,8 +476,7 @@ description: JSON schema reference documentation for GitProxy
503476

504477
<details>
505478
<summary>
506-
<strong> <a name="tempPassword_sendEmail"></a>16.1. [Optional] Property GitProxy configuration file > tempPassword > sendEmail</strong>
507-
479+
<strong> <a name="tempPassword_sendEmail"></a>16.1. [Optional] Property GitProxy configuration file > tempPassword > sendEmail</strong>
508480
</summary>
509481
<blockquote>
510482

@@ -518,8 +490,7 @@ description: JSON schema reference documentation for GitProxy
518490

519491
<details>
520492
<summary>
521-
<strong> <a name="tempPassword_emailConfig"></a>16.2. [Optional] Property GitProxy configuration file > tempPassword > emailConfig</strong>
522-
493+
<strong> <a name="tempPassword_emailConfig"></a>16.2. [Optional] Property GitProxy configuration file > tempPassword > emailConfig</strong>
523494
</summary>
524495
<blockquote>
525496

@@ -538,4 +509,4 @@ description: JSON schema reference documentation for GitProxy
538509
</details>
539510

540511
----------------------------------------------------------------------------------------------------------------------------
541-
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2024-10-22 at 16:44:20 +0100
512+
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2024-10-22 at 16:45:32 +0100

0 commit comments

Comments
 (0)