Convert XML API entries to Markdown for Jekyll#62
Conversation
Agent-Logs-Url: https://github.com/jquery-validation/validation-content/sessions/56c60609-42d5-4470-b53a-8ba170e29227 Co-authored-by: bytestream <1788397+bytestream@users.noreply.github.com>
Agent-Logs-Url: https://github.com/jquery-validation/validation-content/sessions/56c60609-42d5-4470-b53a-8ba170e29227 Co-authored-by: bytestream <1788397+bytestream@users.noreply.github.com>
Agent-Logs-Url: https://github.com/jquery-validation/validation-content/sessions/56c60609-42d5-4470-b53a-8ba170e29227 Co-authored-by: bytestream <1788397+bytestream@users.noreply.github.com>
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>
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>
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>
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>
Agent-Logs-Url: https://github.com/jquery-validation/validation-content/sessions/5608e6dd-347c-4281-81b1-3c53a3aeeac1 Co-authored-by: bytestream <1788397+bytestream@users.noreply.github.com>
Agent-Logs-Url: https://github.com/jquery-validation/validation-content/sessions/5608e6dd-347c-4281-81b1-3c53a3aeeac1 Co-authored-by: bytestream <1788397+bytestream@users.noreply.github.com>
Agent-Logs-Url: https://github.com/jquery-validation/validation-content/sessions/b166165c-b300-451d-a303-726d7d88061c Co-authored-by: bytestream <1788397+bytestream@users.noreply.github.com>
Agent-Logs-Url: https://github.com/jquery-validation/validation-content/sessions/b166165c-b300-451d-a303-726d7d88061c Co-authored-by: bytestream <1788397+bytestream@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR migrates the site content/build pipeline from the legacy XML/Grunt-based generation to a Jekyll 4.x GitHub Pages site using Markdown + front matter.
Changes:
- Replace JSON-in-
<script>page metadata with Jekyll front matter; add a newdefaultlayout. - Convert XML API entries into
_entries/*.mdand remove the XML/XSLT/Grunt/Node toolchain files. - Add Jekyll 4 configuration, Gem dependencies, and a GitHub Actions workflow to build/deploy to Pages.
Reviewed changes
Copilot reviewed 92 out of 94 changed files in this pull request and generated 13 comments.
Show a summary per file
| File | Description |
|---|---|
| reference.md | Switches to Jekyll front matter for page metadata. |
| pages/index.html | Removes legacy generated HTML home page. |
| package.json | Removes Node/Grunt dependency manifest. |
| package-lock.json | Removes Node lockfile tied to old pipeline. |
| notes.xsl | Removes unused XSLT artifact from XML build. |
| index.md | Adds new Markdown-based home page for Jekyll. |
| entries2html.xsl | Removes XSLT used to transform XML entries. |
| entries/validate.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| entries/valid.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| entries/url-method.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| entries/step-method.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| entries/rules.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| entries/required-method.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| entries/require_from_group-method.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| entries/remote-method.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| entries/rangelength-method.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| entries/range-method.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| entries/phoneUS-method.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| entries/number-method.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| entries/minlength-method.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| entries/min-method.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| entries/maxlength-method.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| entries/max-method.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| entries/jQuery.validator.setDefaults.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| entries/jQuery.validator.methods.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| entries/jQuery.validator.format.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| entries/jQuery.validator.addMethod.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| entries/jQuery.validator.addClassRules.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| entries/filled-selector.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| entries/extension-method.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| entries/equalTo-method.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| entries/email-method.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| entries/digits-method.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| entries/dateISO-method.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| entries/date-method.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| entries/creditcard-method.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| entries/blank-selector.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| entries/accept-method.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| entries/Validator.showErrors.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| entries/Validator.resetForm.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| entries/Validator.numberOfInvalids.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| entries/Validator.form.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| entries/Validator.element.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| entries/Validator.destroy.xml | Removes legacy XML entry (replaced by Markdown collection item). |
| documentation.md | Switches to Jekyll front matter for page metadata. |
| contribute.md | Switches to Jekyll front matter for page metadata. |
| config-sample.json | Removes legacy WordPress deployment configuration sample. |
| categories.xml | Removes legacy XML categories definition. |
| _layouts/default.html | Adds a new Jekyll layout with header/nav and base styling. |
| _entries/validate.md | Adds Markdown version of .validate() API entry. |
| _entries/valid.md | Adds Markdown version of .valid() API entry. |
| _entries/url-method.md | Adds Markdown version of url method entry. |
| _entries/unchecked-selector.md | Converts selector entry from XML to Markdown. |
| _entries/step-method.md | Adds Markdown version of step method entry. |
| _entries/rules.md | Adds Markdown version of .rules() entry. |
| _entries/required-method.md | Adds Markdown version of required method entry. |
| _entries/require_from_group-method.md | Adds Markdown version of require_from_group entry. |
| _entries/remote-method.md | Adds Markdown version of remote method entry. |
| _entries/rangelength-method.md | Adds Markdown version of rangelength method entry. |
| _entries/range-method.md | Adds Markdown version of range method entry. |
| _entries/phoneUS-method.md | Adds Markdown version of phoneUS method entry. |
| _entries/number-method.md | Adds Markdown version of number method entry. |
| _entries/normalizer.md | Converts method entry from XML to Markdown and adds examples. |
| _entries/minlength-method.md | Adds Markdown version of minlength method entry. |
| _entries/min-method.md | Adds Markdown version of min method entry. |
| _entries/maxlength-method.md | Adds Markdown version of maxlength method entry. |
| _entries/max-method.md | Adds Markdown version of max method entry. |
| _entries/jQuery.validator.setDefaults.md | Adds Markdown version of validator API entry. |
| _entries/jQuery.validator.methods.md | Adds Markdown version of validator API entry. |
| _entries/jQuery.validator.format.md | Adds Markdown version of validator API entry. |
| _entries/jQuery.validator.addMethod.md | Adds Markdown version of validator API entry. |
| _entries/jQuery.validator.addClassRules.md | Adds Markdown version of validator API entry. |
| _entries/filled-selector.md | Adds Markdown version of selector entry. |
| _entries/extension-method.md | Adds Markdown version of extension method entry. |
| _entries/equalTo-method.md | Adds Markdown version of equalTo method entry. |
| _entries/email-method.md | Adds Markdown version of email method entry. |
| _entries/digits-method.md | Adds Markdown version of digits method entry. |
| _entries/dateISO-method.md | Adds Markdown version of dateISO method entry. |
| _entries/date-method.md | Adds Markdown version of deprecated date method entry. |
| _entries/creditcard-method.md | Adds Markdown version of creditcard method entry. |
| _entries/blank-selector.md | Adds Markdown version of selector entry. |
| _entries/accept-method.md | Adds Markdown version of accept method entry. |
| _entries/Validator.showErrors.md | Adds Markdown version of validator API entry. |
| _entries/Validator.resetForm.md | Adds Markdown version of validator API entry. |
| _entries/Validator.numberOfInvalids.md | Adds Markdown version of validator API entry. |
| _entries/Validator.form.md | Adds Markdown version of validator API entry. |
| _entries/Validator.element.md | Adds Markdown version of validator API entry. |
| _entries/Validator.destroy.md | Adds Markdown version of validator API entry. |
| _config.yml | Adds Jekyll configuration including entries collection and kramdown settings. |
| README.md | Updates docs for Jekyll/Ruby-based local development and Pages deployment. |
| Gruntfile.js | Removes legacy Grunt pipeline configuration. |
| Gemfile | Adds Jekyll 4.x + plugin dependencies for Bundler. |
| .gitignore | Updates ignore rules for Jekyll build artifacts. |
| .github/workflows/deploy-pages.yml | Adds GitHub Actions workflow to build and deploy to GitHub Pages. |
Comments suppressed due to low confidence (2)
_entries/normalizer.md:97
- Typo in code comment: “validatng” → “validating”.
_entries/normalizer.md:16 - Typo in docs: “overrided” → “overridden”.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| For a quick overview of what this plugin provides, check out this [Webucator](https://www.webucator.com/) video (they also provide [jQuery trainings](https://www.webucator.com/webdesign/jquery.cfm)): | ||
|
|
||
| <iframe width="560" height="315" src="//www.youtube.com/embed/yaxUV3Ib4vM" frameborder="0" allowfullscreen></iframe> |
There was a problem hiding this comment.
The embedded YouTube <iframe> is missing a title attribute, which is required for accessible iframe content (screen readers need a label). Add a descriptive title (and consider adding loading="lazy" to reduce initial page load).
| **rules** *(Any)* (default: `rules are read from markup (classes, attributes, data)`) | ||
|
|
||
| Key/value pairs defining custom rules. Key is the name of an element (or a group of checkboxes/radio buttons), value is an object consisting of rule/parameter pairs or a plain String. Can be combined with class/attribute/data rules. Each rule can be specified as having a depends-property to apply the rule only in certain conditions. See the second example below for details. Example: Specifies a name element as required and an email element as required (using the shortcut for a single rule) and a valid email address (using another object literal). $("#myform").validate({ rules: { // simple rule, converted to {required:true} name: "required", // compound rule email: { required: true, email: true } } }); Example: Specifies a contact element as required and as email address, the latter depending on a checkbox being checked for contact via email. $("#myform").validate({ rules: { contact: { required: true, email: { depends: function(element) { return $("#contactform_email").is(":checked"); } } } } }); Example: Configure a rule that requires a parameter, along with a `depends` callback. $("#myform").validate({ rules: { // at least 15€ when bonus material is included pay_what_you_want: { required: true min: { // min needs a parameter passed to it param: 15, depends: function(element) { return $("#bonus-material").is(":checked"); } } } } }); |
There was a problem hiding this comment.
The rules examples are embedded inline and at least one is syntactically invalid JavaScript (pay_what_you_want: { required: true min: { ... } } is missing a comma after required: true). This makes the docs misleading; consider rendering these as fenced code blocks and fixing the object literal syntax.
|
@staabm this PR works Would you be happy to enable GitHub pages for the repo?
|
Agent-Logs-Url: https://github.com/jquery-validation/validation-content/sessions/20cc6850-ea77-41ca-9390-971b0d581239 Co-authored-by: bytestream <1788397+bytestream@users.noreply.github.com>
Agent-Logs-Url: https://github.com/jquery-validation/validation-content/sessions/8bc572b0-b97a-4158-8713-9aa7a99fa1a8 Co-authored-by: bytestream <1788397+bytestream@users.noreply.github.com>
…tax errors Agent-Logs-Url: https://github.com/jquery-validation/validation-content/sessions/0436e5d0-b9c5-4ceb-874b-044476769828 Co-authored-by: bytestream <1788397+bytestream@users.noreply.github.com>
|
This is working but does need some manual review to correct a few differences... if happy to use GitHub pages then I'll continue but will await a 👍🏼 before putting more time into this. |
|
Nice. 👍 please go ahead
yes. Please give me a ping when you I should enable the setting |

Uh oh!
There was an error while loading. Please reload this page.