Skip to content

Commit

Permalink
chore: correct mdx changes to avoid breaking the build
Browse files Browse the repository at this point in the history
  • Loading branch information
@06kellyjac
06kellyjac committed Oct 17, 2024
1 parent 083572c commit 6517407
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 30 deletions.
2 changes: 1 addition & 1 deletion scripts/doc-schema.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ try {
console.log(genDocOutput);

const schemaDoc = readFileSync(`${tempdir}${sep}schema.md`, 'utf-8')
.replace(/\n\n<\/summary>/g, '</summary>')
.replace(/\s\s\n\n<\/summary>/g, '\n</summary>')
.replace(/# GitProxy configuration file/g, '# Schema Reference'); // https://github.com/finos/git-proxy/pull/327#discussion_r1377343213
const docString = `---
title: Schema Reference
Expand Down
86 changes: 57 additions & 29 deletions website/docs/configuration/reference.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ description: JSON schema reference documentation for GitProxy

<details>
<summary>
<strong> <a name="proxyUrl"></a>1. [Optional] Property GitProxy configuration file > proxyUrl</strong> </summary>
<strong> <a name="proxyUrl"></a>1. [Optional] Property GitProxy configuration file > proxyUrl</strong>
</summary>
<blockquote>

| | |
Expand All @@ -30,7 +31,8 @@ description: JSON schema reference documentation for GitProxy

<details>
<summary>
<strong> <a name="cookieSecret"></a>2. [Optional] Property GitProxy configuration file > cookieSecret</strong> </summary>
<strong> <a name="cookieSecret"></a>2. [Optional] Property GitProxy configuration file > cookieSecret</strong>
</summary>
<blockquote>

| | |
Expand All @@ -43,7 +45,8 @@ description: JSON schema reference documentation for GitProxy

<details>
<summary>
<strong> <a name="sessionMaxAgeHours"></a>3. [Optional] Property GitProxy configuration file > sessionMaxAgeHours</strong> </summary>
<strong> <a name="sessionMaxAgeHours"></a>3. [Optional] Property GitProxy configuration file > sessionMaxAgeHours</strong>
</summary>
<blockquote>

| | |
Expand All @@ -56,7 +59,8 @@ description: JSON schema reference documentation for GitProxy

<details>
<summary>
<strong> <a name="api"></a>4. [Optional] Property GitProxy configuration file > api</strong> </summary>
<strong> <a name="api"></a>4. [Optional] Property GitProxy configuration file > api</strong>
</summary>
<blockquote>

| | |
Expand All @@ -72,7 +76,8 @@ description: JSON schema reference documentation for GitProxy

<details>
<summary>
<strong> <a name="commitConfig"></a>5. [Optional] Property GitProxy configuration file > commitConfig</strong> </summary>
<strong> <a name="commitConfig"></a>5. [Optional] Property GitProxy configuration file > commitConfig</strong>
</summary>
<blockquote>

| | |
Expand All @@ -88,7 +93,8 @@ description: JSON schema reference documentation for GitProxy

<details>
<summary>
<strong> <a name="attestationConfig"></a>6. [Optional] Property GitProxy configuration file > attestationConfig</strong> </summary>
<strong> <a name="attestationConfig"></a>6. [Optional] Property GitProxy configuration file > attestationConfig</strong>
</summary>
<blockquote>

| | |
Expand All @@ -104,7 +110,8 @@ description: JSON schema reference documentation for GitProxy

<details>
<summary>
<strong> <a name="domains"></a>7. [Optional] Property GitProxy configuration file > domains</strong> </summary>
<strong> <a name="domains"></a>7. [Optional] Property GitProxy configuration file > domains</strong>
</summary>
<blockquote>

| | |
Expand All @@ -120,7 +127,8 @@ description: JSON schema reference documentation for GitProxy

<details>
<summary>
<strong> <a name="privateOrganizations"></a>8. [Optional] Property GitProxy configuration file > privateOrganizations</strong> </summary>
<strong> <a name="privateOrganizations"></a>8. [Optional] Property GitProxy configuration file > privateOrganizations</strong>
</summary>
<blockquote>

| | |
Expand All @@ -135,7 +143,8 @@ description: JSON schema reference documentation for GitProxy

<details>
<summary>
<strong> <a name="urlShortener"></a>9. [Optional] Property GitProxy configuration file > urlShortener</strong> </summary>
<strong> <a name="urlShortener"></a>9. [Optional] Property GitProxy configuration file > urlShortener</strong>
</summary>
<blockquote>

| | |
Expand All @@ -150,7 +159,8 @@ description: JSON schema reference documentation for GitProxy

<details>
<summary>
<strong> <a name="contactEmail"></a>10. [Optional] Property GitProxy configuration file > contactEmail</strong> </summary>
<strong> <a name="contactEmail"></a>10. [Optional] Property GitProxy configuration file > contactEmail</strong>
</summary>
<blockquote>

| | |
Expand All @@ -165,7 +175,8 @@ description: JSON schema reference documentation for GitProxy

<details>
<summary>
<strong> <a name="csrfProtection"></a>11. [Optional] Property GitProxy configuration file > csrfProtection</strong> </summary>
<strong> <a name="csrfProtection"></a>11. [Optional] Property GitProxy configuration file > csrfProtection</strong>
</summary>
<blockquote>

| | |
Expand All @@ -180,7 +191,8 @@ description: JSON schema reference documentation for GitProxy

<details>
<summary>
<strong> <a name="authorisedList"></a>12. [Optional] Property GitProxy configuration file > authorisedList</strong> </summary>
<strong> <a name="authorisedList"></a>12. [Optional] Property GitProxy configuration file > authorisedList</strong>
</summary>
<blockquote>

| | |
Expand All @@ -205,7 +217,8 @@ description: JSON schema reference documentation for GitProxy

<details>
<summary>
<strong> <a name="authorisedList_items_project"></a>12.1.1. [Required] Property GitProxy configuration file > authorisedList > authorisedList items > project</strong> </summary>
<strong> <a name="authorisedList_items_project"></a>12.1.1. [Required] Property GitProxy configuration file > authorisedList > authorisedList items > project</strong>
</summary>
<blockquote>

| | |
Expand All @@ -218,7 +231,8 @@ description: JSON schema reference documentation for GitProxy

<details>
<summary>
<strong> <a name="authorisedList_items_name"></a>12.1.2. [Required] Property GitProxy configuration file > authorisedList > authorisedList items > name</strong> </summary>
<strong> <a name="authorisedList_items_name"></a>12.1.2. [Required] Property GitProxy configuration file > authorisedList > authorisedList items > name</strong>
</summary>
<blockquote>

| | |
Expand All @@ -231,7 +245,8 @@ description: JSON schema reference documentation for GitProxy

<details>
<summary>
<strong> <a name="authorisedList_items_url"></a>12.1.3. [Required] Property GitProxy configuration file > authorisedList > authorisedList items > url</strong> </summary>
<strong> <a name="authorisedList_items_url"></a>12.1.3. [Required] Property GitProxy configuration file > authorisedList > authorisedList items > url</strong>
</summary>
<blockquote>

| | |
Expand All @@ -247,7 +262,8 @@ description: JSON schema reference documentation for GitProxy

<details>
<summary>
<strong> <a name="sink"></a>13. [Optional] Property GitProxy configuration file > sink</strong> </summary>
<strong> <a name="sink"></a>13. [Optional] Property GitProxy configuration file > sink</strong>
</summary>
<blockquote>

| | |
Expand All @@ -272,7 +288,8 @@ description: JSON schema reference documentation for GitProxy

<details>
<summary>
<strong> <a name="sink_items_type"></a>13.1.1. [Required] Property GitProxy configuration file > sink > sink items > type</strong> </summary>
<strong> <a name="sink_items_type"></a>13.1.1. [Required] Property GitProxy configuration file > sink > sink items > type</strong>
</summary>
<blockquote>

| | |
Expand All @@ -285,7 +302,8 @@ description: JSON schema reference documentation for GitProxy

<details>
<summary>
<strong> <a name="sink_items_enabled"></a>13.1.2. [Required] Property GitProxy configuration file > sink > sink items > enabled</strong> </summary>
<strong> <a name="sink_items_enabled"></a>13.1.2. [Required] Property GitProxy configuration file > sink > sink items > enabled</strong>
</summary>
<blockquote>

| | |
Expand All @@ -298,7 +316,8 @@ description: JSON schema reference documentation for GitProxy

<details>
<summary>
<strong> <a name="sink_items_connectionString"></a>13.1.3. [Optional] Property GitProxy configuration file > sink > sink items > connectionString</strong> </summary>
<strong> <a name="sink_items_connectionString"></a>13.1.3. [Optional] Property GitProxy configuration file > sink > sink items > connectionString</strong>
</summary>
<blockquote>

| | |
Expand All @@ -311,7 +330,8 @@ description: JSON schema reference documentation for GitProxy

<details>
<summary>
<strong> <a name="sink_items_options"></a>13.1.4. [Optional] Property GitProxy configuration file > sink > sink items > options</strong> </summary>
<strong> <a name="sink_items_options"></a>13.1.4. [Optional] Property GitProxy configuration file > sink > sink items > options</strong>
</summary>
<blockquote>

| | |
Expand All @@ -325,7 +345,8 @@ description: JSON schema reference documentation for GitProxy

<details>
<summary>
<strong> <a name="sink_items_params"></a>13.1.5. [Optional] Property GitProxy configuration file > sink > sink items > params</strong> </summary>
<strong> <a name="sink_items_params"></a>13.1.5. [Optional] Property GitProxy configuration file > sink > sink items > params</strong>
</summary>
<blockquote>

| | |
Expand All @@ -342,7 +363,8 @@ description: JSON schema reference documentation for GitProxy

<details>
<summary>
<strong> <a name="authentication"></a>14. [Optional] Property GitProxy configuration file > authentication</strong> </summary>
<strong> <a name="authentication"></a>14. [Optional] Property GitProxy configuration file > authentication</strong>
</summary>
<blockquote>

| | |
Expand All @@ -367,7 +389,8 @@ description: JSON schema reference documentation for GitProxy

<details>
<summary>
<strong> <a name="authentication_items_type"></a>14.1.1. [Required] Property GitProxy configuration file > authentication > authentication items > type</strong> </summary>
<strong> <a name="authentication_items_type"></a>14.1.1. [Required] Property GitProxy configuration file > authentication > authentication items > type</strong>
</summary>
<blockquote>

| | |
Expand All @@ -380,7 +403,8 @@ description: JSON schema reference documentation for GitProxy

<details>
<summary>
<strong> <a name="authentication_items_enabled"></a>14.1.2. [Required] Property GitProxy configuration file > authentication > authentication items > enabled</strong> </summary>
<strong> <a name="authentication_items_enabled"></a>14.1.2. [Required] Property GitProxy configuration file > authentication > authentication items > enabled</strong>
</summary>
<blockquote>

| | |
Expand All @@ -393,7 +417,8 @@ description: JSON schema reference documentation for GitProxy

<details>
<summary>
<strong> <a name="authentication_items_options"></a>14.1.3. [Optional] Property GitProxy configuration file > authentication > authentication items > options</strong> </summary>
<strong> <a name="authentication_items_options"></a>14.1.3. [Optional] Property GitProxy configuration file > authentication > authentication items > options</strong>
</summary>
<blockquote>

| | |
Expand All @@ -410,7 +435,8 @@ description: JSON schema reference documentation for GitProxy

<details>
<summary>
<strong> <a name="tempPassword"></a>15. [Optional] Property GitProxy configuration file > tempPassword</strong> </summary>
<strong> <a name="tempPassword"></a>15. [Optional] Property GitProxy configuration file > tempPassword</strong>
</summary>
<blockquote>

| | |
Expand All @@ -423,7 +449,8 @@ description: JSON schema reference documentation for GitProxy

<details>
<summary>
<strong> <a name="tempPassword_sendEmail"></a>15.1. [Optional] Property GitProxy configuration file > tempPassword > sendEmail</strong> </summary>
<strong> <a name="tempPassword_sendEmail"></a>15.1. [Optional] Property GitProxy configuration file > tempPassword > sendEmail</strong>
</summary>
<blockquote>

| | |
Expand All @@ -436,7 +463,8 @@ description: JSON schema reference documentation for GitProxy

<details>
<summary>
<strong> <a name="tempPassword_emailConfig"></a>15.2. [Optional] Property GitProxy configuration file > tempPassword > emailConfig</strong> </summary>
<strong> <a name="tempPassword_emailConfig"></a>15.2. [Optional] Property GitProxy configuration file > tempPassword > emailConfig</strong>
</summary>
<blockquote>

| | |
Expand All @@ -454,4 +482,4 @@ description: JSON schema reference documentation for GitProxy
</details>

----------------------------------------------------------------------------------------------------------------------------
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

0 comments on commit 6517407

Please sign in to comment.