Merge pull request #62 from jquery-validation/copilot/convert-repo-to-github-pages

Switch to Jekyll

Author: bytestream

.github/dependabot.yml

@@ -0,0 +1,17 @@
+version: 2
+updates:
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "daily"
+
+  - package-ecosystem: 'bundler'
+    directory: '/'
+    schedule:
+      interval: 'daily'

.github/workflows/deploy-pages.yml

@@ -0,0 +1,61 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+      - master
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'npm'
+
+      - name: Install npm dependencies and copy libs
+        run: |
+          npm ci
+          npm run copy-libs
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Build with Jekyll
+        uses: actions/jekyll-build-pages@v1
+        with:
+          source: ./
+          destination: ./_site
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -1,3 +1,5 @@
-dist
-node_modules
-config.json
+/.jekyll-cache/
+/_site/
+/Gemfile.lock
+/node_modules/
+/lib/

Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gem "jekyll", "~> 4.3"
+gem "webrick", "~> 1.8"  # Required for Jekyll 4 on Ruby 3.0+
+
+group :jekyll_plugins do
+  gem "jekyll-feed", "~> 0.17"
+end

Gruntfile.js

@@ -1,35 +1,69 @@
-jqueryvalidation-content
-========================
+# jQuery Validation Plugin - Content Repository
 
-## Building
+This repository contains the documentation and content for the [jQuery Validation Plugin](https://github.com/jquery-validation/jquery-validation) website.
 
-### Requirements
+## GitHub Pages Deployment
 
-* <a href="http://www.xmlsoft.org/">libxml2</a>
-* <a href="http://xmlsoft.org/XSLT/">libxslt</a>
+This site is automatically deployed to GitHub Pages using Jekyll.
 
-The `xmllint` and `xsltproc` utilities need to be in your path. If you are on Windows, you can get libxml2 and libxslt from <a href="http://www.zlatkovic.com/libxml.en.html">GnuWin32</a>.
+### How it Works
 
-* Install [WordPress](http://wordpress.org/download/)
-* Install [jqueryvalidation-theme](https://github.com/jzaefferer/validation-theme) - clone that repo, then symlink it into your `wp-content/themes` folder
-* Install [gilded-wordpress plugin](https://raw.githubusercontent.com/scottgonzalez/gilded-wordpress/v1.0.0/gilded-wordpress.php)
-* Install [jquery-static-index plugin](https://raw.githubusercontent.com/jquery/jquery-wp-content/v4.0.1/plugins/jquery-static-index.php)
+- Content is written in Markdown with Jekyll front matter
+- The site is built using Jekyll (configured in `_config.yml`)
+- GitHub Actions automatically builds and deploys the site when changes are pushed to the `main` or `master` branch
+- The workflow is defined in `.github/workflows/deploy-pages.yml`
 
-### Installation
+### Local Development
 
-In this repo:
-* Make sure nodejs (with npm) is installed, otherwise install from nodejs.org
-* `cp config-sample.json config.json`, edit config.json to match login for local WordPress
-* run `npm install -g grunt-cli`
-* run `npm install`
+To test the site locally:
 
-### Hacks
+1. Install Ruby 2.7 or higher and Bundler:
+   ```bash
+   gem install bundler
+   ```
 
-* Make sure your local `wordpress` nodejs module contains [this commit](https://github.com/scottgonzalez/node-wordpress/commit/2b19238cf8064dafb66b9db09d0adcc9eac7f724)
-* Make sure your local config contains
-  * rpc-auth and basic-auth credentials
-  * a https jqueryvalidation url
+2. Install dependencies:
+   ```bash
+   bundle install
+   npm install
+   npm run copy-libs
+   ```
 
-### Deploy
+3. Run Jekyll locally:
+   ```bash
+   bundle exec jekyll serve
+   ```
 
-`grunt deploy`
+4. Open your browser to `http://localhost:4000/validation-content/`
+
+**Note:** This site uses Jekyll 4.x. If you encounter issues, ensure you have Ruby 2.7 or higher installed.
+
+### Making Changes
+
+1. Edit or create Markdown files (`.md`) in the root directory
+2. Each file should have Jekyll front matter at the top:
+   ```yaml
+   ---
+   layout: default
+   title: Your Page Title
+   ---
+   ```
+3. Commit and push your changes
+4. GitHub Actions will automatically build and deploy the site
+
+### Content Structure
+
+- `index.md` - Home page
+- `documentation.md` - API documentation
+- `contribute.md` - Contribution guide
+- `reference.md` - General guidelines and reference
+- `_entries/` - Markdown documentation entries (for API methods, converted from XML)
+- `_layouts/` - Jekyll layout templates
+
+### Deployment
+
+The site is automatically deployed via GitHub Actions when:
+- Changes are pushed to `main` or `master` branch
+- The workflow can also be triggered manually from the Actions tab
+
+No manual deployment is required!

README.md

@@ -0,0 +1,35 @@
+title: jQuery Validation Plugin
+description: Site content for the jQuery Validation Plugin
+url: https://jquery-validation.github.io
+baseurl: ""
+
+# Build settings
+markdown: kramdown
+kramdown:
+  input: GFM
+  syntax_highlighter: rouge
+
+# Exclude from processing
+exclude:
+  - README.md
+  - LICENSE-MIT.txt
+  - .gitignore
+  - .gitattributes
+  - Gemfile
+  - Gemfile.lock
+  - node_modules
+  - package.json
+  - package-lock.json
+
+# Collections
+collections:
+  entries:
+    output: true
+    permalink: /:name/
+
+defaults:
+  - scope:
+      path: ""
+      type: "entries"
+    values:
+      layout: "default"

_config.yml

@@ -0,0 +1,47 @@
+---
+title: Validator.destroy()
+entry_name: Validator.destroy
+entry_type: method
+category: validator
+layout: default
+permalink: /Validator.destroy/
+---
+
+# Validator.destroy()
+
+Destroys this instance of validator freeing up resources and unregistering events.
+
+## Description
+
+This is only useful, when you need to clean up after the validator in a Single Page Application.
+
+## Usage
+
+### `Validator.destroy()`
+{:.signature}
+
+<div class="signature-body" markdown="1">
+
+This signature does not accept any arguments.
+
+</div>
+
+## Examples
+
+Destroying an instance of validator.
+
+```javascript
+/*
+ * On SPA page start.
+ */
+var validator = $( "#myform" ).validate();
+
+/*
+ * Just before SPA page's navigation away.
+ */
+validator.destroy();
+
+/*
+ * After this point the #myForm form is back to its original boring state.
+ */
+```

_entries/Validator.destroy.md

@@ -0,0 +1,38 @@
+---
+title: Validator.element()
+entry_name: Validator.element
+entry_type: method
+category: validator
+layout: default
+permalink: /Validator.element/
+---
+
+# Validator.element()
+
+Validates a single element, returns true if it is valid, false otherwise.
+
+## Description
+
+This behaves as validation on blur or keyup, but returns the result.
+
+## Usage
+
+### `Validator.element( element )`
+{:.signature}
+
+<div class="signature-body" markdown="1">
+
+**element** *(Selector)*
+
+An element to validate, must be inside the validated form.
+
+</div>
+
+## Examples
+
+Triggers element validation programmatically.
+
+```javascript
+var validator = $( "#myform" ).validate();
+validator.element( "#myselect" );
+```

_entries/Validator.element.md

@@ -0,0 +1,36 @@
+---
+title: Validator.form()
+entry_name: Validator.form
+entry_type: method
+category: validator
+layout: default
+permalink: /Validator.form/
+---
+
+# Validator.form()
+
+Validates the form, returns true if it is valid, false otherwise.
+
+## Description
+
+This behaves as a normal submit event, but returns the result.
+
+## Usage
+
+### `Validator.form()`
+{:.signature}
+
+<div class="signature-body" markdown="1">
+
+This signature does not accept any arguments.
+
+</div>
+
+## Examples
+
+Triggers form validation programmatically.
+
+```javascript
+var validator = $( "#myform" ).validate();
+validator.form();
+```