diff --git a/examples/docs/deepextending.schema.md b/examples/docs/deepextending.schema.md index 9b124da0c73ac81241152c9c42b5974340d34425..3c1fc445690979fbe6830782c829efa769af80ba 100644 --- a/examples/docs/deepextending.schema.md +++ b/examples/docs/deepextending.schema.md @@ -36,7 +36,7 @@ This is an extending schema. It is extending another extending schema. It pulls ## @id -An `id` with an `@` in front of it. The `@` stands for "dot com" +An `id` with an `@` in front of it. The `@` stands for "dot com" `@id` * is optional @@ -87,7 +87,7 @@ A horse walks into it. ## baz ### BAAAZ! -This property has a unique name to demonstrate it's uniqueness. +This property has a unique name to demonstrate it's uniqueness. `baz` * is optional diff --git a/examples/docs/definitions.schema.md b/examples/docs/definitions.schema.md index fbd3031c9d1f091e85e1be3f06f914669974a710..97bceaa6341a22614206154e009e733c1b256cb9 100644 --- a/examples/docs/definitions.schema.md +++ b/examples/docs/definitions.schema.md @@ -25,6 +25,9 @@ Bre- aks. +> Everything is better with a quote. + + | [Abstract](../abstract.md) | Extensible | [Status](../status.md) | Custom Properties | Additional Properties | Defined In | |----------------------------|------------|------------------------|-------------------|-----------------------|------------| | Can be instantiated | Yes | Experimental | Forbidden | Permitted | [definitions.schema.json](definitions.schema.json) | @@ -40,7 +43,7 @@ aks. ## @id -An `id` with an `@` in front of it. The `@` stands for "dot com" +An `id` with an `@` in front of it. The `@` stands for "dot com" `@id` * is optional diff --git a/examples/docs/extending.schema.md b/examples/docs/extending.schema.md index e6b6b5f09f3784312987179f04f4d679e8afcdf7..a34d9c6821b2b2a0979a77ca249e4e2301ef5ab8 100644 --- a/examples/docs/extending.schema.md +++ b/examples/docs/extending.schema.md @@ -34,7 +34,7 @@ This is an extending schema. It pulls `definitions` from other schemas. ## @id -An `id` with an `@` in front of it. The `@` stands for "dot com" +An `id` with an `@` in front of it. The `@` stands for "dot com" `@id` * is optional @@ -85,7 +85,7 @@ A horse walks into it. ## baz ### BAAAZ! -This property has a unique name to demonstrate it's uniqueness. +This property has a unique name to demonstrate it's uniqueness. `baz` * is optional diff --git a/examples/docs/simpletypes.schema.md b/examples/docs/simpletypes.schema.md index 549ce86d2561baa0318fcce74b51ec9295c938ef..6e89018ba9b58428aa21f901927529a5c80691a4 100644 --- a/examples/docs/simpletypes.schema.md +++ b/examples/docs/simpletypes.schema.md @@ -61,7 +61,7 @@ Guess what number is valid ## interger_constrained -Just a whole number. I don't like fractions. Don't get too small +Just a whole number. I don't like fractions. Don't get too small `interger_constrained` * is optional @@ -81,7 +81,7 @@ Just a whole number. I don't like fractions. Don't get too small ## interger_unconstrained -Just a whole number. I don't like fractions. +Just a whole number. I don't like fractions. `interger_unconstrained` * is optional @@ -100,7 +100,7 @@ Just a whole number. I don't like fractions. ## number_constrained -Just a number. Don't get too big. +Just a number. Don't get too big. `number_constrained` * is optional diff --git a/examples/generated-schemas/definitions.schema.json b/examples/generated-schemas/definitions.schema.json index a276e1a2874e81c97a1ba02c4334ca2537b85967..723215f96320c92c8e4ea7594bce383ed2717157 100644 --- a/examples/generated-schemas/definitions.schema.json +++ b/examples/generated-schemas/definitions.schema.json @@ -38,5 +38,5 @@ "required": [ "id" ], - "description": "This is an example of using a `definitions` object within a schema.\n\nIt is imported using `allOf` and `$ref`.\n\nAnd the description has line breaks.\n\nSo.\n\nMany.\n\nLine.\n\nBre-\n\naks." + "description": "This is an example of using a `definitions` object within a schema.\n\nIt is imported using `allOf` and `$ref`.\n\nAnd the description has line breaks.\n\nSo.\n\nMany.\n\nLine.\n\nBre-\n\naks.\n\n> Everything is better with a quote.\n" } \ No newline at end of file diff --git a/examples/schemas/definitions.description.md b/examples/schemas/definitions.description.md index d4afa54fb209dcff1f0e346b2cbb4828f18e8fbd..17353951dd2599a27bab94393fd398911769e63c 100644 --- a/examples/schemas/definitions.description.md +++ b/examples/schemas/definitions.description.md @@ -12,4 +12,6 @@ Line. Bre- -aks. \ No newline at end of file +aks. + +> Everything is better with a quote. diff --git a/spec/examples/deepextending.schema.md b/spec/examples/deepextending.schema.md index 9b124da0c73ac81241152c9c42b5974340d34425..3c1fc445690979fbe6830782c829efa769af80ba 100644 --- a/spec/examples/deepextending.schema.md +++ b/spec/examples/deepextending.schema.md @@ -36,7 +36,7 @@ This is an extending schema. It is extending another extending schema. It pulls ## @id -An `id` with an `@` in front of it. The `@` stands for "dot com" +An `id` with an `@` in front of it. The `@` stands for "dot com" `@id` * is optional @@ -87,7 +87,7 @@ A horse walks into it. ## baz ### BAAAZ! -This property has a unique name to demonstrate it's uniqueness. +This property has a unique name to demonstrate it's uniqueness. `baz` * is optional diff --git a/spec/examples/definitions.schema.md b/spec/examples/definitions.schema.md index fbd3031c9d1f091e85e1be3f06f914669974a710..97bceaa6341a22614206154e009e733c1b256cb9 100644 --- a/spec/examples/definitions.schema.md +++ b/spec/examples/definitions.schema.md @@ -25,6 +25,9 @@ Bre- aks. +> Everything is better with a quote. + + | [Abstract](../abstract.md) | Extensible | [Status](../status.md) | Custom Properties | Additional Properties | Defined In | |----------------------------|------------|------------------------|-------------------|-----------------------|------------| | Can be instantiated | Yes | Experimental | Forbidden | Permitted | [definitions.schema.json](definitions.schema.json) | @@ -40,7 +43,7 @@ aks. ## @id -An `id` with an `@` in front of it. The `@` stands for "dot com" +An `id` with an `@` in front of it. The `@` stands for "dot com" `@id` * is optional diff --git a/spec/examples/extending.schema.md b/spec/examples/extending.schema.md index e6b6b5f09f3784312987179f04f4d679e8afcdf7..a34d9c6821b2b2a0979a77ca249e4e2301ef5ab8 100644 --- a/spec/examples/extending.schema.md +++ b/spec/examples/extending.schema.md @@ -34,7 +34,7 @@ This is an extending schema. It pulls `definitions` from other schemas. ## @id -An `id` with an `@` in front of it. The `@` stands for "dot com" +An `id` with an `@` in front of it. The `@` stands for "dot com" `@id` * is optional @@ -85,7 +85,7 @@ A horse walks into it. ## baz ### BAAAZ! -This property has a unique name to demonstrate it's uniqueness. +This property has a unique name to demonstrate it's uniqueness. `baz` * is optional diff --git a/spec/examples/simpletypes.schema.md b/spec/examples/simpletypes.schema.md index 549ce86d2561baa0318fcce74b51ec9295c938ef..6e89018ba9b58428aa21f901927529a5c80691a4 100644 --- a/spec/examples/simpletypes.schema.md +++ b/spec/examples/simpletypes.schema.md @@ -61,7 +61,7 @@ Guess what number is valid ## interger_constrained -Just a whole number. I don't like fractions. Don't get too small +Just a whole number. I don't like fractions. Don't get too small `interger_constrained` * is optional @@ -81,7 +81,7 @@ Just a whole number. I don't like fractions. Don't get too small ## interger_unconstrained -Just a whole number. I don't like fractions. +Just a whole number. I don't like fractions. `interger_unconstrained` * is optional @@ -100,7 +100,7 @@ Just a whole number. I don't like fractions. ## number_constrained -Just a number. Don't get too big. +Just a number. Don't get too big. `number_constrained` * is optional diff --git a/templates/md/array-type.ejs b/templates/md/array-type.ejs index e6237c2e2e60939143a5e0e4a4e6c33842fc312c..ad9c13f5a9e69823c5e61a999598b6d6e48f1890 100644 --- a/templates/md/array-type.ejs +++ b/templates/md/array-type.ejs @@ -36,7 +36,7 @@ Unknown type `<%= schema.items.type %>`. <% if (schema.items.description!==undefined) { %> -<%= (""+schema.items.description).replace(/\n/g, '\n\n') %> +<%- (""+schema.items.description).replace(/\n/g, '\n\n') %> <% } %> diff --git a/templates/md/header.ejs b/templates/md/header.ejs index 7d7f38c5922c589b6ebdcf4baea5213dba36140f..2bc989e1378021a999be993baa7599af8a5f986f 100644 --- a/templates/md/header.ejs +++ b/templates/md/header.ejs @@ -12,7 +12,7 @@ ``` -<%= schema.description.replace(/\n/g, '\n\n') %> +<%- schema.description.replace(/\n/g, '\n\n') %> <%= table %> diff --git a/templates/md/nested-property.ejs b/templates/md/nested-property.ejs index 0a3f8437763d0af3f38c8869fc2ad6fac847cb18..11b6222180db1a49e2d30f4674f66ecbc3047c45 100644 --- a/templates/md/nested-property.ejs +++ b/templates/md/nested-property.ejs @@ -9,7 +9,7 @@ <% if (schema.title) { %>##### <%= schema.title %><% } %> -<%= (""+schema.description).replace(/\n/g, '\n\n') %> +<%- (""+schema.description).replace(/\n/g, '\n\n') %> `<%=name %>` diff --git a/templates/md/pattern-property.ejs b/templates/md/pattern-property.ejs index 6c84cf3d0b1d4c4fef441feb2149d966079c999f..5af51557c02795a9ffc99b7020e4200f3ae7b10a 100644 --- a/templates/md/pattern-property.ejs +++ b/templates/md/pattern-property.ejs @@ -12,7 +12,7 @@ Applies to all properties that match the regular expression `<%=name %>` <% if (schema.title) { %>### <%= schema.title %><% } %> <% if (schema.description) { %> -<%= schema.description.replace(/\n/g, '\n\n') %> +<%- schema.description.replace(/\n/g, '\n\n') %> <% } %> `<%=name %>` diff --git a/templates/md/property.ejs b/templates/md/property.ejs index 522c68f8bcbff6dc1da5728327c8179bf62733df..b4edeb2d336f53e7c79e1812f2d422727d1eda6f 100644 --- a/templates/md/property.ejs +++ b/templates/md/property.ejs @@ -9,7 +9,7 @@ <% if (schema.title) { %>### <%= schema.title %><% } %> <% if (schema.description) { %> -<%= schema.description.replace(/\n/g, '\n\n') %> +<%- schema.description.replace(/\n/g, '\n\n') %> <% } %> `<%=name %>`