Improve XML to Markdown conversion formatting

Copilot · bytestream · web-flow · commit a0ffcfc1a7d1 · 2026-04-07T11:32:47.000Z
Agent-Logs-Url: https://github.com/jquery-validation/validation-content/sessions/3cd3a909-bae0-4790-b477-0bccbaf09aac Co-authored-by: bytestream <1788397+bytestream@users.noreply.github.com>
diff --git a/_entries/Validator.element.md b/_entries/Validator.element.md
@@ -17,7 +17,8 @@ This behaves as validation on blur or keyup, but returns the result.
 ## Usage
 
 **element** *(Selector)*
-: An element to validate, must be inside the validated form.
+
+An element to validate, must be inside the validated form.
 
 ## Examples
 
diff --git a/_entries/Validator.numberOfInvalids.md b/_entries/Validator.numberOfInvalids.md
@@ -17,7 +17,8 @@ This depends on the internal validator state. It covers all fields only after va
 ## Usage
 
 **errors** *(Object)*
-: One or more key/value pairs of input names and messages.
+
+One or more key/value pairs of input names and messages.
 
 ## Examples
 
diff --git a/_entries/Validator.showErrors.md b/_entries/Validator.showErrors.md
@@ -17,7 +17,8 @@ Keys have to refer to the names of elements, values are displayed for those elem
 ## Usage
 
 **errors** *(Object)*
-: One or more key/value pairs of input names and messages.
+
+One or more key/value pairs of input names and messages.
 
 ## Examples
 
diff --git a/_entries/accept-method.md b/_entries/accept-method.md
@@ -18,7 +18,8 @@ Uses the HTML5 file API to look at the type attribute of one or more selected fi
 ## Usage
 
 **mimetype** *(String)*
-: The allowed type, seperated via ",", defaults to "image/*"
+
+The allowed type, seperated via ",", defaults to "image/*"
 
 ## Examples
 
diff --git a/_entries/equalTo-method.md b/_entries/equalTo-method.md
@@ -18,7 +18,8 @@ Returns true if the value has the same value as the element specified by the fir
 ## Usage
 
 **other** *(Selector)*
-: The selector for the element to compare the current values
+
+The selector for the element to compare the current values
 
 ## Examples
 
diff --git a/_entries/extension-method.md b/_entries/extension-method.md
@@ -18,7 +18,8 @@ Returns true if the value ends with one of the specified file extensions. If not
 ## Usage
 
 **extension** *(String)* (optional)
-: The allowed file extensions, seperated with "|" (or a comma, ","), defaults to "png|jpe?g|gif".
+
+The allowed file extensions, seperated with "|" (or a comma, ","), defaults to "png|jpe?g|gif".
 
 ## Examples
 
diff --git a/_entries/jQuery.validator.addClassRules.md b/_entries/jQuery.validator.addClassRules.md
@@ -15,15 +15,18 @@ Add a compound class method - useful to refactor common combinations of rules in
 ### Form 1
 
 **name** *(String)*
-: The name of the class rule to add
+
+The name of the class rule to add
 
 **rules** *(Object)*
-: The compound rules (see example)
+
+The compound rules (see example)
 
 ### Form 2
 
 **rules** *(Object)*
-: A map of className-rules pairs (see example).
+
+A map of className-rules pairs (see example).
 
 ## Examples
 
diff --git a/_entries/jQuery.validator.addMethod.md b/_entries/jQuery.validator.addMethod.md
@@ -17,17 +17,28 @@ For simple one-off validation, you can use the bundled `pattern` method (in addi
 ## Usage
 
 **name** *(String)*
-: The name of the method used to identify it and referencing it; this must be a valid JavaScript identifier
+
+The name of the method used to identify it and referencing it; this must be a valid JavaScript identifier
 
 **method** *(Function)*
-: The actual method implementation, returning true if an element is valid. First argument: Current value. Second argument: Validated element. Third argument: Parameters.
 
-  - **value** *(String)*: the current value of the validated element
-  - **element** *(Element)*: the element to be validated
-  - **params** *(Object)*: parameters specified for the method, e.g. for min: 5, the parameter is 5, for range: [1, 5] it's [1, 5]
+The actual method implementation, returning true if an element is valid. First argument: Current value. Second argument: Validated element. Third argument: Parameters.
+
+  **value** *(String)*
+
+  the current value of the validated element
+
+  **element** *(Element)*
+
+  the element to be validated
+
+  **params** *(Object)*
+
+  parameters specified for the method, e.g. for min: 5, the parameter is 5, for range: [1, 5] it's [1, 5]
 
 **message** *(String)* (optional)
-: The default message to display for this method. Can be a function created by ''jQuery.validator.format(value)''. When undefined, an existing message is used (handy for localization), otherwise the field-specific messages have to be defined.
+
+The default message to display for this method. Can be a function created by ''jQuery.validator.format(value)''. When undefined, an existing message is used (handy for localization), otherwise the field-specific messages have to be defined.
 
 ## Examples
 
diff --git a/_entries/jQuery.validator.format.md b/_entries/jQuery.validator.format.md
@@ -17,13 +17,16 @@ One or more arguments can be passed, in addition to the string template itself,
 ## Usage
 
 **template** *(String)*
-: The string to format.
+
+The string to format.
 
 **argument** *(Object)*
-: The first argument to insert, or an array of Strings to insert
+
+The first argument to insert, or an array of Strings to insert
 
 **argumentN...** *(Object)*
-: The second etc. argument to insert
+
+The second etc. argument to insert
 
 ## Examples
 
diff --git a/_entries/jQuery.validator.setDefaults.md b/_entries/jQuery.validator.setDefaults.md
@@ -17,7 +17,8 @@ Accepts everything that [validate()](/validate) accepts.
 ## Usage
 
 **options** *(Object)*
-: Options to set as default.
+
+Options to set as default.
 
 ## Examples
 
diff --git a/_entries/max-method.md b/_entries/max-method.md
@@ -18,7 +18,8 @@ Works with text inputs. To exclude the maximum value, subtract Number.MIN_VALUE
 ## Usage
 
 **value** *(Number)*
-: Maximum value required
+
+Maximum value required
 
 ## Examples
 
diff --git a/_entries/maxlength-method.md b/_entries/maxlength-method.md
@@ -18,7 +18,8 @@ Return false if the element is some kind of text input and its value is too long
 ## Usage
 
 **length** *(Number)*
-: Maximum number of characters required
+
+Maximum number of characters required
 
 ## Examples
 
diff --git a/_entries/min-method.md b/_entries/min-method.md
@@ -18,7 +18,8 @@ Works with text inputs. To exclude the minimum value, add Number.MIN_VALUE to th
 ## Usage
 
 **value** *(Number)*
-: Minimum value required
+
+Minimum value required
 
 ## Examples
 
diff --git a/_entries/minlength-method.md b/_entries/minlength-method.md
@@ -18,7 +18,8 @@ Return false if the element is some kind of text input and its value is too shor
 ## Usage
 
 **length** *(Number)*
-: Minimum number of characters required
+
+Minimum number of characters required
 
 ## Examples
 
diff --git a/_entries/normalizer.md b/_entries/normalizer.md
@@ -18,7 +18,8 @@ Transform the value of an element and the result for validation instead of the i
 ## Usage
 
 **value** *(String)*
-: The value of the element.
+
+The value of the element.
 
 ## Examples
 
diff --git a/_entries/range-method.md b/_entries/range-method.md
@@ -18,7 +18,8 @@ Works with text inputs. To exclude the maximum value, subtract Number.MIN_VALUE
 ## Usage
 
 **range** *(Array)*
-: Value range required
+
+Value range required
 
 ## Examples
 
diff --git a/_entries/rangelength-method.md b/_entries/rangelength-method.md
@@ -18,7 +18,8 @@ Return false if the element is some kind of text input and its length is too sho
 ## Usage
 
 **range** *(Array)*
-: Value range required
+
+Value range required
 
 ## Examples
 
diff --git a/_entries/remote-method.md b/_entries/remote-method.md
@@ -18,7 +18,8 @@ The serverside resource is called via jQuery.ajax (XMLHttpRequest) and gets a ke
 ## Usage
 
 **options** *(Object)*
-: For the URL of the resource to request for serverside validation (String) or options to fully customize the request, see [jQuery.ajax](https://api.jquery.com/jQuery.ajax) for details. These options deep-extend the defaults (`dataType:"json", data:{nameOfTheElement:valueOfTheElement}`). Any options you provide will override the defaults.
+
+For the URL of the resource to request for serverside validation (String) or options to fully customize the request, see [jQuery.ajax](https://api.jquery.com/jQuery.ajax) for details. These options deep-extend the defaults (`dataType:"json", data:{nameOfTheElement:valueOfTheElement}`). Any options you provide will override the defaults.
 
 ## Examples
 
diff --git a/_entries/required-method.md b/_entries/required-method.md
@@ -26,14 +26,16 @@ The element is always required.
 Makes the element required, depending on the result of the given expression.
 
 **dependency-expression** *(String)*
-: An expression (String) that is evaluated in the context of the element's form, making the field required only if the expression returns more than one element. Very often your expression will use selector filters such as `#foo:checked`, `#foo:filled`, `#foo:visible`. This plugin provides [custom selectors for that purpose](/category/selectors/).
+
+An expression (String) that is evaluated in the context of the element's form, making the field required only if the expression returns more than one element. Very often your expression will use selector filters such as `#foo:checked`, `#foo:filled`, `#foo:visible`. This plugin provides [custom selectors for that purpose](/category/selectors/).
 
 ### Form 3
 
 Makes the element required, depending on the result of the given callback.
 
 **dependency-callback** *(Function)*
-: The function is executed with the element as it's only argument: If it returns true, the element is required.
+
+The function is executed with the element as it's only argument: If it returns true, the element is required.
 
 ## Examples
 
diff --git a/_entries/rules.md b/_entries/rules.md
@@ -28,7 +28,8 @@ Add rules
 **"add"** *(String)*
 
 **rules** *(Object)*
-: The rules to add. Accepts the same format as the rules-option of the validate-method.
+
+The rules to add. Accepts the same format as the rules-option of the validate-method.
 
 ### Form 3
 
@@ -37,7 +38,8 @@ Remove rules
 **"remove"** *(String)*
 
 **rules** *(Object)*
-: The space-seperated names of rules to remove and return. If left unspecified, removes and returns all rules. Manipulates only rules specified via rules-option or via rules("add").
+
+The space-seperated names of rules to remove and return. If left unspecified, removes and returns all rules. Manipulates only rules specified via rules-option or via rules("add").
 
 ## Examples
 
diff --git a/_entries/step-method.md b/_entries/step-method.md
@@ -18,7 +18,8 @@ Works with text inputs. No support for input types: date, datetime, datetime-loc
 ## Usage
 
 **value** *(Number)*
-: Step value required
+
+Step value required
 
 ## Examples
 
diff --git a/_entries/validate.md b/_entries/validate.md
diff --git a/convert_entries.py b/convert_entries.py
