Skip to content

Commit

Permalink
Allow headings up to level 6 (#230)
Browse files Browse the repository at this point in the history
* Allow headings up to level 6

We have lots of nested properties, and would like to get to `<h6>`, which is the max.

* Update test cases

---------

Co-authored-by: Denis Blanchette <[email protected]>
  • Loading branch information
dasch and dblanchette authored May 1, 2024
1 parent 0956d85 commit 3fcad9c
Show file tree
Hide file tree
Showing 55 changed files with 221 additions and 221 deletions.
14 changes: 7 additions & 7 deletions docs/examples/examples_flat_default/Configuration.html
Original file line number Diff line number Diff line change
Expand Up @@ -416,7 +416,7 @@ <h2 class="mb-0">

<p>Extract the default value of a property from the description like this: <code>[Default `the_default_value`]</code>.</p>

<p>The default value from the "default" attribute will be used in priority.</p>
<p>The default value from the &#34;default&#34; attribute will be used in priority.</p>



Expand Down Expand Up @@ -586,8 +586,8 @@ <h2 class="mb-0">


<div class="enum-value" id="template_name_enum">
<h4>Must be one of:</h4>
<ul class="list-group"><li class="list-group-item enum-item">"flat"</li><li class="list-group-item enum-item">"js"</li><li class="list-group-item enum-item">"js_offline"</li><li class="list-group-item enum-item">"md"</li><li class="list-group-item enum-item">"md_nested"</li></ul>
<h4>Must be one of:</h4>
<ul class="list-group"><li class="list-group-item enum-item">"flat"</li><li class="list-group-item enum-item">"js"</li><li class="list-group-item enum-item">"js_offline"</li><li class="list-group-item enum-item">"md"</li><li class="list-group-item enum-item">"md_nested"</li></ul>
</div>


Expand Down Expand Up @@ -782,7 +782,7 @@ <h2 class="mb-0">
<p><a href="https://github.com/trentm/python-markdown2/wiki/Extras">Markdown 2 options</a> for the descriptions. <code>description_is_markdown</code> must be true for this to have any effect.</p>

<p><strong>WARNING</strong><br />
Adding an extra, even if the value is false, will activate it. For example <code>{"break-on-newline": false}</code> will activate the <code>break-on-newline</code> extra.</p>
Adding an extra, even if the value is false, will activate it. For example <code>{&amp;#34;break-on-newline&amp;#34;: false}</code> will activate the <code>break-on-newline</code> extra.</p>



Expand Down Expand Up @@ -1017,7 +1017,7 @@ <h2 class="mb-0">

<p>array of column names to display in the properties table.</p>

<p>if empty, the default is ['Property','Pattern','Type','Deprecated','Definition','Title/Description']</p>
<p>if empty, the default is [&#39;Property&#39;,&#39;Pattern&#39;,&#39;Type&#39;,&#39;Deprecated&#39;,&#39;Definition&#39;,&#39;Title/Description&#39;]</p>



Expand Down Expand Up @@ -1067,8 +1067,8 @@ <h2 class="mb-0">


<div class="enum-value" id="template_md_options_properties_table_columns_items_enum">
<h4>Must be one of:</h4>
<ul class="list-group"><li class="list-group-item enum-item">"Property"</li><li class="list-group-item enum-item">"Pattern"</li><li class="list-group-item enum-item">"Type"</li><li class="list-group-item enum-item">"Deprecated"</li><li class="list-group-item enum-item">"Definition"</li><li class="list-group-item enum-item">"Title/Description"</li></ul>
<h4>Must be one of:</h4>
<ul class="list-group"><li class="list-group-item enum-item">"Property"</li><li class="list-group-item enum-item">"Pattern"</li><li class="list-group-item enum-item">"Type"</li><li class="list-group-item enum-item">"Deprecated"</li><li class="list-group-item enum-item">"Definition"</li><li class="list-group-item enum-item">"Title/Description"</li></ul>
</div>


Expand Down
10 changes: 5 additions & 5 deletions docs/examples/examples_flat_default/array_additionalItems.html
Original file line number Diff line number Diff line change
Expand Up @@ -182,8 +182,8 @@ <h5>Item at 3 must be:</h5>


<div class="enum-value" id="address_items_i2_enum">
<h4>Must be one of:</h4>
<ul class="list-group"><li class="list-group-item enum-item">"Street"</li><li class="list-group-item enum-item">"Avenue"</li><li class="list-group-item enum-item">"Boulevard"</li></ul>
<h4>Must be one of:</h4>
<ul class="list-group"><li class="list-group-item enum-item">"Street"</li><li class="list-group-item enum-item">"Avenue"</li><li class="list-group-item enum-item">"Boulevard"</li></ul>
</div>


Expand Down Expand Up @@ -226,8 +226,8 @@ <h5>Item at 4 must be:</h5>


<div class="enum-value" id="address_items_i3_enum">
<h4>Must be one of:</h4>
<ul class="list-group"><li class="list-group-item enum-item">"NW"</li><li class="list-group-item enum-item">"NE"</li><li class="list-group-item enum-item">"SW"</li><li class="list-group-item enum-item">"SE"</li></ul>
<h4>Must be one of:</h4>
<ul class="list-group"><li class="list-group-item enum-item">"NW"</li><li class="list-group-item enum-item">"NE"</li><li class="list-group-item enum-item">"SW"</li><li class="list-group-item enum-item">"SE"</li></ul>
</div>


Expand Down Expand Up @@ -354,7 +354,7 @@ <h2 class="mb-0">



<p>This is not a valid JSON Schema, but let's do it anyway.</p>
<p>This is not a valid JSON Schema, but let&#39;s do it anyway.</p>



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,8 @@ <h5>Item at 3 must be:</h5>


<div class="enum-value" id="items_i2_enum">
<h4>Must be one of:</h4>
<ul class="list-group"><li class="list-group-item enum-item">"Street"</li><li class="list-group-item enum-item">"Avenue"</li><li class="list-group-item enum-item">"Boulevard"</li></ul>
<h4>Must be one of:</h4>
<ul class="list-group"><li class="list-group-item enum-item">"Street"</li><li class="list-group-item enum-item">"Avenue"</li><li class="list-group-item enum-item">"Boulevard"</li></ul>
</div>


Expand Down Expand Up @@ -161,8 +161,8 @@ <h5>Item at 4 must be:</h5>


<div class="enum-value" id="items_i3_enum">
<h4>Must be one of:</h4>
<ul class="list-group"><li class="list-group-item enum-item">"NW"</li><li class="list-group-item enum-item">"NE"</li><li class="list-group-item enum-item">"SW"</li><li class="list-group-item enum-item">"SE"</li></ul>
<h4>Must be one of:</h4>
<ul class="list-group"><li class="list-group-item enum-item">"NW"</li><li class="list-group-item enum-item">"NE"</li><li class="list-group-item enum-item">"SW"</li><li class="list-group-item enum-item">"SE"</li></ul>
</div>


Expand Down
4 changes: 2 additions & 2 deletions docs/examples/examples_flat_default/basic.html
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ <h2 class="mb-0">



<p>The person's first name.</p>
<p>The person&#39;s first name.</p>



Expand Down Expand Up @@ -94,7 +94,7 @@ <h2 class="mb-0">



<p>The person's last name.</p>
<p>The person&#39;s last name.</p>



Expand Down
2 changes: 1 addition & 1 deletion docs/examples/examples_flat_default/broken_ref.html
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ <h2 class="mb-0">



<p>The person's first name.</p>
<p>The person&#39;s first name.</p>



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -350,8 +350,8 @@ <h2 class="mb-0">


<div class="enum-value" id="country_enum">
<h4>Must be one of:</h4>
<ul class="list-group"><li class="list-group-item enum-item">"United States of America"</li><li class="list-group-item enum-item">"Canada"</li></ul>
<h4>Must be one of:</h4>
<ul class="list-group"><li class="list-group-item enum-item">"United States of America"</li><li class="list-group-item enum-item">"Canada"</li></ul>
</div>


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -910,8 +910,8 @@ <h2 class="mb-0">


<div class="enum-value" id="country_enum">
<h4>Must be one of:</h4>
<ul class="list-group"><li class="list-group-item enum-item">"United States of America"</li><li class="list-group-item enum-item">"Canada"</li><li class="list-group-item enum-item">"Netherlands"</li></ul>
<h4>Must be one of:</h4>
<ul class="list-group"><li class="list-group-item enum-item">"United States of America"</li><li class="list-group-item enum-item">"Canada"</li><li class="list-group-item enum-item">"Netherlands"</li></ul>
</div>


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ <h2 class="mb-0">



<p>I don't know why you would want an empty property 🤷</p>
<p>I don&#39;t know why you would want an empty property 🤷</p>



Expand Down
4 changes: 2 additions & 2 deletions docs/examples/examples_flat_default/enumofnone.html
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@ <h2 class="mb-0">


<div class="enum-value" id="enumOfNone_enum">
<h4>Must be one of:</h4>
<ul class="list-group"><li class="list-group-item enum-item">null</li></ul>
<h4>Must be one of:</h4>
<ul class="list-group"><li class="list-group-item enum-item">null</li></ul>
</div>


Expand Down
2 changes: 1 addition & 1 deletion docs/examples/examples_flat_default/long_description.html
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ <h2 class="mb-0">



<p>This property is really complicated. To explain it we need a whole lot of text, I'm telling you. It all started in 1919 when the children were playing outside and not with computers like kids these days. At the time, I thought to myself "I should create a JSON Schema with a property that is really hard to explain". I did not know what a JSON schema was, in fact I was not alive at the time, but that's what happened, trust me. Anyway this property represents your dreams, but like if your dreams was the reality, but not really. I told you it was hard to explain... In case this is not long enough, here is a Fable of La Fontaine: Rien ne sert de courir ; il faut partir à point. Le Lièvre et la Tortue en sont un témoignage. Gageons, dit celle-ci, que vous n'atteindrez point Sitôt que moi ce but. — Sitôt ? Êtes-vous sage ? Repartit l'animal léger. Ma commère, il vous faut purger Avec quatre grains d'ellébore. — Sage ou non, je parie encore. Ainsi fut fait : et de tous deux On mit près du but les enjeux : Savoir quoi, ce n'est pas l'affaire, Ni de quel juge l'on convint. Notre Lièvre n'avait que quatre pas à faire ; J'entends de ceux qu'il fait lorsque prêt d'être atteint Il s'éloigne des chiens, les renvoie aux Calendes, Et leur fait arpenter les landes. Ayant, dis-je, du temps de reste pour brouter, Pour dormir, et pour écouter D'où vient le vent, il laisse la Tortue Aller son train de Sénateur. Elle part, elle s'évertue ; Elle se hâte avec lenteur. Lui cependant méprise une telle victoire, Tient la gageure à peu de gloire, Croit qu'il y va de son honneur De partir tard. Il broute, il se repose, Il s'amuse à toute autre chose Qu'à la gageure. À la fin quand il vit Que l'autre touchait presque au bout de la carrière, Il partit comme un trait ; mais les élans qu'il fit Furent vains : la Tortue arriva la première. Eh bien ! lui cria-t-elle, avais-je pas raison ? De quoi vous sert votre vitesse ? Moi, l'emporter ! et que serait-ce Si vous portiez une maison ?</p>
<p>This property is really complicated. To explain it we need a whole lot of text, I&#39;m telling you. It all started in 1919 when the children were playing outside and not with computers like kids these days. At the time, I thought to myself &#34;I should create a JSON Schema with a property that is really hard to explain&#34;. I did not know what a JSON schema was, in fact I was not alive at the time, but that&#39;s what happened, trust me. Anyway this property represents your dreams, but like if your dreams was the reality, but not really. I told you it was hard to explain... In case this is not long enough, here is a Fable of La Fontaine: Rien ne sert de courir ; il faut partir à point. Le Lièvre et la Tortue en sont un témoignage. Gageons, dit celle-ci, que vous n&#39;atteindrez point Sitôt que moi ce but. — Sitôt ? Êtes-vous sage ? Repartit l&#39;animal léger. Ma commère, il vous faut purger Avec quatre grains d&#39;ellébore. — Sage ou non, je parie encore. Ainsi fut fait : et de tous deux On mit près du but les enjeux : Savoir quoi, ce n&#39;est pas l&#39;affaire, Ni de quel juge l&#39;on convint. Notre Lièvre n&#39;avait que quatre pas à faire ; J&#39;entends de ceux qu&#39;il fait lorsque prêt d&#39;être atteint Il s&#39;éloigne des chiens, les renvoie aux Calendes, Et leur fait arpenter les landes. Ayant, dis-je, du temps de reste pour brouter, Pour dormir, et pour écouter D&#39;où vient le vent, il laisse la Tortue Aller son train de Sénateur. Elle part, elle s&#39;évertue ; Elle se hâte avec lenteur. Lui cependant méprise une telle victoire, Tient la gageure à peu de gloire, Croit qu&#39;il y va de son honneur De partir tard. Il broute, il se repose, Il s&#39;amuse à toute autre chose Qu&#39;à la gageure. À la fin quand il vit Que l&#39;autre touchait presque au bout de la carrière, Il partit comme un trait ; mais les élans qu&#39;il fit Furent vains : la Tortue arriva la première. Eh bien ! lui cria-t-elle, avais-je pas raison ? De quoi vous sert votre vitesse ? Moi, l&#39;emporter ! et que serait-ce Si vous portiez une maison ?</p>



Expand Down
4 changes: 2 additions & 2 deletions docs/examples/examples_flat_default/multiple_types.html
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ <h2 class="mb-0">



<p>The person's first name.</p>
<p>The person&#39;s first name.</p>



Expand Down Expand Up @@ -94,7 +94,7 @@ <h2 class="mb-0">



<p>The person's last name.</p>
<p>The person&#39;s last name.</p>



Expand Down
4 changes: 2 additions & 2 deletions docs/examples/examples_flat_default/pattern_properties.html
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ <h2 class="mb-0">



<p>The person's first name.</p>
<p>The person&#39;s first name.</p>



Expand Down Expand Up @@ -94,7 +94,7 @@ <h2 class="mb-0">



<p>The person's last name.</p>
<p>The person&#39;s last name.</p>



Expand Down
8 changes: 4 additions & 4 deletions docs/examples/examples_flat_default/prefixItems.html
Original file line number Diff line number Diff line change
Expand Up @@ -183,8 +183,8 @@ <h5>Item at 3 must be:</h5>


<div class="enum-value" id="address_items_i2_enum">
<h4>Must be one of:</h4>
<ul class="list-group"><li class="list-group-item enum-item">"Street"</li><li class="list-group-item enum-item">"Avenue"</li><li class="list-group-item enum-item">"Boulevard"</li></ul>
<h4>Must be one of:</h4>
<ul class="list-group"><li class="list-group-item enum-item">"Street"</li><li class="list-group-item enum-item">"Avenue"</li><li class="list-group-item enum-item">"Boulevard"</li></ul>
</div>


Expand Down Expand Up @@ -227,8 +227,8 @@ <h5>Item at 4 must be:</h5>


<div class="enum-value" id="address_items_i3_enum">
<h4>Must be one of:</h4>
<ul class="list-group"><li class="list-group-item enum-item">"NW"</li><li class="list-group-item enum-item">"NE"</li><li class="list-group-item enum-item">"SW"</li><li class="list-group-item enum-item">"SE"</li></ul>
<h4>Must be one of:</h4>
<ul class="list-group"><li class="list-group-item enum-item">"NW"</li><li class="list-group-item enum-item">"NE"</li><li class="list-group-item enum-item">"SW"</li><li class="list-group-item enum-item">"SE"</li></ul>
</div>


Expand Down
4 changes: 2 additions & 2 deletions docs/examples/examples_flat_default/ref_merge.html
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,8 @@ <h2 class="mb-0">


<div class="enum-value" id="aProperty_enum">
<h4>Must be one of:</h4>
<ul class="list-group"><li class="list-group-item enum-item">"value1"</li><li class="list-group-item enum-item">"value2"</li></ul>
<h4>Must be one of:</h4>
<ul class="list-group"><li class="list-group-item enum-item">"value1"</li><li class="list-group-item enum-item">"value2"</li></ul>
</div>


Expand Down
Loading

0 comments on commit 3fcad9c

Please sign in to comment.