From 6517407c4dbbde5bbfc86f9a2b30ef7362c933b5 Mon Sep 17 00:00:00 2001 From: Jack Kelly Date: Thu, 17 Oct 2024 16:26:08 +0100 Subject: [PATCH] chore: correct mdx changes to avoid breaking the build --- scripts/doc-schema.js | 2 +- website/docs/configuration/reference.mdx | 86 ++++++++++++++++-------- 2 files changed, 58 insertions(+), 30 deletions(-) diff --git a/scripts/doc-schema.js b/scripts/doc-schema.js index 9cfeab6ce..9f4e7e007 100644 --- a/scripts/doc-schema.js +++ b/scripts/doc-schema.js @@ -20,7 +20,7 @@ try { console.log(genDocOutput); const schemaDoc = readFileSync(`${tempdir}${sep}schema.md`, 'utf-8') - .replace(/\n\n<\/summary>/g, '') + .replace(/\s\s\n\n<\/summary>/g, '\n') .replace(/# GitProxy configuration file/g, '# Schema Reference'); // https://github.com/finos/git-proxy/pull/327#discussion_r1377343213 const docString = `--- title: Schema Reference diff --git a/website/docs/configuration/reference.mdx b/website/docs/configuration/reference.mdx index b1468ca0b..654be42f7 100644 --- a/website/docs/configuration/reference.mdx +++ b/website/docs/configuration/reference.mdx @@ -17,7 +17,8 @@ description: JSON schema reference documentation for GitProxy
- 1. [Optional] Property GitProxy configuration file > proxyUrl + 1. [Optional] Property GitProxy configuration file > proxyUrl +
| | | @@ -30,7 +31,8 @@ description: JSON schema reference documentation for GitProxy
- 2. [Optional] Property GitProxy configuration file > cookieSecret + 2. [Optional] Property GitProxy configuration file > cookieSecret +
| | | @@ -43,7 +45,8 @@ description: JSON schema reference documentation for GitProxy
- 3. [Optional] Property GitProxy configuration file > sessionMaxAgeHours + 3. [Optional] Property GitProxy configuration file > sessionMaxAgeHours +
| | | @@ -56,7 +59,8 @@ description: JSON schema reference documentation for GitProxy
- 4. [Optional] Property GitProxy configuration file > api + 4. [Optional] Property GitProxy configuration file > api +
| | | @@ -72,7 +76,8 @@ description: JSON schema reference documentation for GitProxy
- 5. [Optional] Property GitProxy configuration file > commitConfig + 5. [Optional] Property GitProxy configuration file > commitConfig +
| | | @@ -88,7 +93,8 @@ description: JSON schema reference documentation for GitProxy
- 6. [Optional] Property GitProxy configuration file > attestationConfig + 6. [Optional] Property GitProxy configuration file > attestationConfig +
| | | @@ -104,7 +110,8 @@ description: JSON schema reference documentation for GitProxy
- 7. [Optional] Property GitProxy configuration file > domains + 7. [Optional] Property GitProxy configuration file > domains +
| | | @@ -120,7 +127,8 @@ description: JSON schema reference documentation for GitProxy
- 8. [Optional] Property GitProxy configuration file > privateOrganizations + 8. [Optional] Property GitProxy configuration file > privateOrganizations +
| | | @@ -135,7 +143,8 @@ description: JSON schema reference documentation for GitProxy
- 9. [Optional] Property GitProxy configuration file > urlShortener + 9. [Optional] Property GitProxy configuration file > urlShortener +
| | | @@ -150,7 +159,8 @@ description: JSON schema reference documentation for GitProxy
- 10. [Optional] Property GitProxy configuration file > contactEmail + 10. [Optional] Property GitProxy configuration file > contactEmail +
| | | @@ -165,7 +175,8 @@ description: JSON schema reference documentation for GitProxy
- 11. [Optional] Property GitProxy configuration file > csrfProtection + 11. [Optional] Property GitProxy configuration file > csrfProtection +
| | | @@ -180,7 +191,8 @@ description: JSON schema reference documentation for GitProxy
- 12. [Optional] Property GitProxy configuration file > authorisedList + 12. [Optional] Property GitProxy configuration file > authorisedList +
| | | @@ -205,7 +217,8 @@ description: JSON schema reference documentation for GitProxy
- 12.1.1. [Required] Property GitProxy configuration file > authorisedList > authorisedList items > project + 12.1.1. [Required] Property GitProxy configuration file > authorisedList > authorisedList items > project +
| | | @@ -218,7 +231,8 @@ description: JSON schema reference documentation for GitProxy
- 12.1.2. [Required] Property GitProxy configuration file > authorisedList > authorisedList items > name + 12.1.2. [Required] Property GitProxy configuration file > authorisedList > authorisedList items > name +
| | | @@ -231,7 +245,8 @@ description: JSON schema reference documentation for GitProxy
- 12.1.3. [Required] Property GitProxy configuration file > authorisedList > authorisedList items > url + 12.1.3. [Required] Property GitProxy configuration file > authorisedList > authorisedList items > url +
| | | @@ -247,7 +262,8 @@ description: JSON schema reference documentation for GitProxy
- 13. [Optional] Property GitProxy configuration file > sink + 13. [Optional] Property GitProxy configuration file > sink +
| | | @@ -272,7 +288,8 @@ description: JSON schema reference documentation for GitProxy
- 13.1.1. [Required] Property GitProxy configuration file > sink > sink items > type + 13.1.1. [Required] Property GitProxy configuration file > sink > sink items > type +
| | | @@ -285,7 +302,8 @@ description: JSON schema reference documentation for GitProxy
- 13.1.2. [Required] Property GitProxy configuration file > sink > sink items > enabled + 13.1.2. [Required] Property GitProxy configuration file > sink > sink items > enabled +
| | | @@ -298,7 +316,8 @@ description: JSON schema reference documentation for GitProxy
- 13.1.3. [Optional] Property GitProxy configuration file > sink > sink items > connectionString + 13.1.3. [Optional] Property GitProxy configuration file > sink > sink items > connectionString +
| | | @@ -311,7 +330,8 @@ description: JSON schema reference documentation for GitProxy
- 13.1.4. [Optional] Property GitProxy configuration file > sink > sink items > options + 13.1.4. [Optional] Property GitProxy configuration file > sink > sink items > options +
| | | @@ -325,7 +345,8 @@ description: JSON schema reference documentation for GitProxy
- 13.1.5. [Optional] Property GitProxy configuration file > sink > sink items > params + 13.1.5. [Optional] Property GitProxy configuration file > sink > sink items > params +
| | | @@ -342,7 +363,8 @@ description: JSON schema reference documentation for GitProxy
- 14. [Optional] Property GitProxy configuration file > authentication + 14. [Optional] Property GitProxy configuration file > authentication +
| | | @@ -367,7 +389,8 @@ description: JSON schema reference documentation for GitProxy
- 14.1.1. [Required] Property GitProxy configuration file > authentication > authentication items > type + 14.1.1. [Required] Property GitProxy configuration file > authentication > authentication items > type +
| | | @@ -380,7 +403,8 @@ description: JSON schema reference documentation for GitProxy
- 14.1.2. [Required] Property GitProxy configuration file > authentication > authentication items > enabled + 14.1.2. [Required] Property GitProxy configuration file > authentication > authentication items > enabled +
| | | @@ -393,7 +417,8 @@ description: JSON schema reference documentation for GitProxy
- 14.1.3. [Optional] Property GitProxy configuration file > authentication > authentication items > options + 14.1.3. [Optional] Property GitProxy configuration file > authentication > authentication items > options +
| | | @@ -410,7 +435,8 @@ description: JSON schema reference documentation for GitProxy
- 15. [Optional] Property GitProxy configuration file > tempPassword + 15. [Optional] Property GitProxy configuration file > tempPassword +
| | | @@ -423,7 +449,8 @@ description: JSON schema reference documentation for GitProxy
- 15.1. [Optional] Property GitProxy configuration file > tempPassword > sendEmail + 15.1. [Optional] Property GitProxy configuration file > tempPassword > sendEmail +
| | | @@ -436,7 +463,8 @@ description: JSON schema reference documentation for GitProxy
- 15.2. [Optional] Property GitProxy configuration file > tempPassword > emailConfig + 15.2. [Optional] Property GitProxy configuration file > tempPassword > emailConfig +
| | | @@ -454,4 +482,4 @@ description: JSON schema reference documentation for GitProxy
---------------------------------------------------------------------------------------------------------------------------- -Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2024-10-17 at 12:14:47 +0100 +Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2024-10-17 at 16:25:54 +0100