Skip to content

feat: Add (read more) links to md format #319

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
roberth wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: Add (read more) links to md format #319

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/examples/cases/basic.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@
{"type": "null", "title": "no driver licence"},
{"type": "string", "title": "driver licence id"}
]
},
"middleName": {
"type": "string",
"title": "Middle Name"
}
}
}
37 changes: 37 additions & 0 deletions docs/examples/examples_flat_default/basic.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,43 @@ <h3 class="ml-2 mt-2"><a id="driverLicenseId_allOf_i1" href="#driverLicenseId_al



</div>
</div>

<div class="card">
<div class="card-header" id="middleName">
<h2 class="mb-0">
<a href="#middleName"><span class="property-name">middleName</span></a></h2>
</div>

<div class="card-body property-definition-div">

<div class="breadcrumbs">root
<svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-arrow-right-short" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
<path
fill-rule="evenodd"
d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
/>
</svg>
<a href="#middleName">middleName</a></div><span class="badge badge-dark value-type">Type: string</span><br/>


















</div>
</div>

Expand Down
33 changes: 33 additions & 0 deletions docs/examples/examples_js_default/basic.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,39 @@ <h2 class="mb-0">



</div>
</div>
</div>
</div>
<div class="accordion" id="accordionmiddleName">
<div class="card">
<div class="card-header" id="headingmiddleName">
<h2 class="mb-0">
<button class="btn btn-link property-name-button" type="button" data-toggle="collapse" data-target="#middleName"
aria-expanded="" aria-controls="middleName" onclick="setAnchor('#middleName')"><span class="property-name">middleName</span></button>
</h2>
</div>

<div id="middleName"
class="collapse property-definition-div" aria-labelledby="headingmiddleName"
data-parent="#accordionmiddleName">
<div class="card-body pl-5">

<div class="breadcrumbs">root
<svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-arrow-right-short" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
<path
fill-rule="evenodd"
d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
/>
</svg>
<a href="#middleName" onclick="anchorLink('middleName')">middleName</a></div><h4>Middle Name</h4><span class="badge badge-dark value-type">Type: string</span><br/>







</div>
</div>
</div>
Expand Down
33 changes: 33 additions & 0 deletions docs/examples/examples_js_offline_default/basic.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,39 @@ <h2 class="mb-0">



</div>
</div>
</div>
</div>
<div class="accordion" id="accordionmiddleName">
<div class="card">
<div class="card-header" id="headingmiddleName">
<h2 class="mb-0">
<button class="btn btn-link property-name-button" type="button" data-toggle="collapse" data-target="#middleName"
aria-expanded="" aria-controls="middleName" onclick="setAnchor('#middleName')"><span class="property-name">middleName</span></button>
</h2>
</div>

<div id="middleName"
class="collapse property-definition-div" aria-labelledby="headingmiddleName"
data-parent="#accordionmiddleName">
<div class="card-body pl-5">

<div class="breadcrumbs">root
<svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-arrow-right-short" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
<path
fill-rule="evenodd"
d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
/>
</svg>
<a href="#middleName" onclick="anchorLink('middleName')">middleName</a></div><h4>Middle Name</h4><span class="badge badge-dark value-type">Type: string</span><br/>







</div>
</div>
</div>
Expand Down
23 changes: 17 additions & 6 deletions docs/examples/examples_md_default/basic.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
- [4. Property `Person > driverLicenseId`](#driverLicenseId)
- [4.1. Property `Person > driverLicenseId > allOf > no driver licence`](#driverLicenseId_allOf_i0)
- [4.2. Property `Person > driverLicenseId > allOf > driver licence id`](#driverLicenseId_allOf_i1)
- [5. Property `Person > middleName`](#middleName)

**Title:** Person

Expand All @@ -15,12 +16,13 @@
| **Required** | No |
| **Additional properties** | Any type allowed |

| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| -------------------------------------- | ------- | ----------- | ---------- | ---------- | ----------------- |
| - [firstName](#firstName ) | No | string | No | - | Person |
| - [lastName](#lastName ) | No | string | No | - | Person |
| - [age](#age ) | No | integer | No | - | Person |
| - [driverLicenseId](#driverLicenseId ) | No | Combination | No | - | - |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| -------------------------------------- | ------- | ----------- | ---------- | ---------- | -------------------------------- |
| - [firstName](#firstName ) | No | string | No | - | Person [(read more)](#firstName) |
| - [lastName](#lastName ) | No | string | No | - | Person [(read more)](#lastName) |
| - [age](#age ) | No | integer | No | - | Person [(read more)](#age) |
| - [driverLicenseId](#driverLicenseId ) | No | Combination | No | - | - |
| - [middleName](#middleName ) | No | string | No | - | Middle Name |

## <a name="firstName"></a>1. Property `Person > firstName`

Expand Down Expand Up @@ -90,5 +92,14 @@
| **Type** | `string` |
| **Required** | No |

## <a name="middleName"></a>5. Property `Person > middleName`

**Title:** Middle Name

| | |
| ------------ | -------- |
| **Type** | `string` |
| **Required** | No |

----------------------------------------------------------------------------------------------------------------------------
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans)
2 changes: 1 addition & 1 deletion docs/examples/examples_md_default/broken_ref.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| -------------------------- | ------- | ------ | ---------- | ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------- |
| - [firstName](#firstName ) | No | string | No | - | Person |
| - [firstName](#firstName ) | No | string | No | - | Person [(read more)](#firstName) |
| - [lastName](#lastName ) | No | object | No | In a_file_that_does_not_exist_and_will_never_i_hope.lol.json | 😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️ |

## <a name="firstName"></a>1. Property `Person > firstName`
Expand Down
10 changes: 5 additions & 5 deletions docs/examples/examples_md_default/html_in_description.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@
| **Required** | No |
| **Additional properties** | Any type allowed |

| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| ---------------------------------------- | ------- | ------ | ---------- | ---------- | --------------------- |
| - [raw_html](#raw_html ) | No | string | No | - | Some raw HTML |
| - [html_in_markdown](#html_in_markdown ) | No | string | No | - | Some HTML in Markdown |
| - [json_in_markdown](#json_in_markdown ) | No | string | No | - | Some JSON in Markdown |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| ---------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------------------ |
| - [raw_html](#raw_html ) | No | string | No | - | Some raw HTML [(read more)](#raw_html) |
| - [html_in_markdown](#html_in_markdown ) | No | string | No | - | Some HTML in Markdown [(read more)](#html_in_markdown) |
| - [json_in_markdown](#json_in_markdown ) | No | string | No | - | Some JSON in Markdown [(read more)](#json_in_markdown) |

## <a name="raw_html"></a>1. Property `HTML in descriptions > raw_html`

Expand Down
18 changes: 9 additions & 9 deletions docs/examples/examples_md_default/pattern_properties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@
| **Required** | No |
| **Additional properties** | Any type allowed |

| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| ---------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
| - [firstName](#firstName ) | No | string | No | - | Person |
| - [lastName](#lastName ) | No | string | No | - | Person |
| - [$[a-c][0-9]^](#pattern1 ) | Yes | object | No | - | paperSize |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| ---------------------------- | ------- | ------ | ---------- | ---------- | ---------------------------------- |
| - [firstName](#firstName ) | No | string | No | - | Person [(read more)](#firstName) |
| - [lastName](#lastName ) | No | string | No | - | Person [(read more)](#lastName) |
| - [$[a-c][0-9]^](#pattern1 ) | Yes | object | No | - | paperSize [(read more)](#pattern1) |

## <a name="firstName"></a>1. Property `Person > firstName`

Expand Down Expand Up @@ -57,10 +57,10 @@ must respect the following conditions

**Description:** Review of a paper size.

| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| ----------------------------- | ------- | ------- | ---------- | ---------- | ----------------- |
| + [rating](#pattern1_rating ) | No | integer | No | - | Rating |
| + [review](#pattern1_review ) | No | string | No | - | Review |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| ----------------------------- | ------- | ------- | ---------- | ---------- | -------------------------------------- |
| + [rating](#pattern1_rating ) | No | integer | No | - | Rating [(read more)](#pattern1_rating) |
| + [review](#pattern1_review ) | No | string | No | - | Review [(read more)](#pattern1_review) |

### <a name="pattern1_rating"></a>3.1. Property `Person > paperSize > rating`

Expand Down
18 changes: 9 additions & 9 deletions docs/examples/examples_md_default/pattern_properties_html_id.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@
| **Required** | No |
| **Additional properties** | Any type allowed |

| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| ---------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
| - [not_a_pattern](#not_a_pattern ) | No | object | No | - | - |
| - [.*](#pattern1 ) | Yes | object | No | - | Title 1 |
| - [..](#pattern2 ) | Yes | object | No | - | Title 2 |
| - [^.](#pattern3 ) | Yes | object | No | - | Title 3 |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| ---------------------------------- | ------- | ------ | ---------- | ---------- | -------------------------------- |
| - [not_a_pattern](#not_a_pattern ) | No | object | No | - | - |
| - [.*](#pattern1 ) | Yes | object | No | - | Title 1 [(read more)](#pattern1) |
| - [..](#pattern2 ) | Yes | object | No | - | Title 2 [(read more)](#pattern2) |
| - [^.](#pattern3 ) | Yes | object | No | - | Title 3 [(read more)](#pattern3) |

## <a name="not_a_pattern"></a>1. Property `Person > not_a_pattern`

Expand All @@ -29,9 +29,9 @@
| **Required** | No |
| **Additional properties** | Any type allowed |

| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| -------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
| - [.$](#not_a_pattern_pattern1 ) | Yes | object | No | - | Title 4 |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| -------------------------------- | ------- | ------ | ---------- | ---------- | ---------------------------------------------- |
| - [.$](#not_a_pattern_pattern1 ) | Yes | object | No | - | Title 4 [(read more)](#not_a_pattern_pattern1) |

### <a name="not_a_pattern_pattern1"></a>1.1. Pattern Property `Person > not_a_pattern > Title 4`
> All properties whose name matches the regular expression
Expand Down
8 changes: 4 additions & 4 deletions docs/examples/examples_md_default/recursive_full_schema.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,10 +96,10 @@
| **Required** | No |
| **Additional properties** | Any type allowed |

| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| ------------------------------------------------------ | ------- | ------ | ---------- | --------------------- | ----------------- |
| - [SomeName](#DecoratedRecursiveArray_items_SomeName ) | No | string | No | - | - |
| - [TheThing](#DecoratedRecursiveArray_items_TheThing ) | No | object | No | Same as [Bug](#root ) | Bug |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| ------------------------------------------------------ | ------- | ------ | ---------- | --------------------- | ---------------------------------------------------------- |
| - [SomeName](#DecoratedRecursiveArray_items_SomeName ) | No | string | No | - | - |
| - [TheThing](#DecoratedRecursiveArray_items_TheThing ) | No | object | No | Same as [Bug](#root ) | Bug [(read more)](#DecoratedRecursiveArray_items_TheThing) |

#### <a name="DecoratedRecursiveArray_items_SomeName"></a>3.1.1. Property `Bug > DecoratedRecursiveArray > DecoratedRecursiveArray items > SomeName`

Expand Down
8 changes: 4 additions & 4 deletions docs/examples/examples_md_default/ref_merge.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@
| **Required** | No |
| **Additional properties** | Any type allowed |

| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| ---------------------------------------------------- | ------- | ---------------- | ---------- | ------------------------------ | --------------------- |
| - [aProperty](#aProperty ) | No | enum (of string) | No | In #/definitions/aProperty | Title from definition |
| - [aDictPropertyARequired](#aDictPropertyARequired ) | No | object | No | In #/definitions/aDictProperty | - |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| ---------------------------------------------------- | ------- | ---------------- | ---------- | ------------------------------ | ----------------------------------------------- |
| - [aProperty](#aProperty ) | No | enum (of string) | No | In #/definitions/aProperty | Title from definition [(read more)](#aProperty) |
| - [aDictPropertyARequired](#aDictPropertyARequired ) | No | object | No | In #/definitions/aDictProperty | - |

## <a name="aProperty"></a>1. Property `Test > aProperty`

Expand Down
Loading