https://github.com/thibaudcolas/detect-wagtail
Detect whether a site or page is built with Wagtail
https://github.com/thibaudcolas/detect-wagtail
detection wagtail wappalyzer
Last synced: about 2 months ago
JSON representation
Detect whether a site or page is built with Wagtail
- Host: GitHub
- URL: https://github.com/thibaudcolas/detect-wagtail
- Owner: thibaudcolas
- License: mit
- Created: 2020-11-12T11:22:44.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-02-13T05:39:33.000Z (3 months ago)
- Last Synced: 2025-03-11T12:12:34.626Z (about 2 months ago)
- Topics: detection, wagtail, wappalyzer
- Language: JavaScript
- Homepage: https://detect-wagtail.netlify.app/
- Size: 1020 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# [Detect Wagtail 
](https://detect-wagtail.netlify.app/)
> Detect whether a site or page is built with [Wagtail](https://github.com/wagtail/wagtail).
## Usage
You can run the detection with:
- The online website, [detect-wagtail.netlify.app](https://detect-wagtail.netlify.app/).
- A bookmarklet, also available from [detect-wagtail.netlify.app](https://detect-wagtail.netlify.app/).
- A browser extension thanks to [Wappalyzer](https://www.wappalyzer.com/technologies/cms/wagtail/).
- A Node CLI, also thanks to [Wappalyzer](https://github.com/httparchive/wappalyzer).
- As an npm package for more custom needs, [detect-wagtail](https://www.npmjs.com/package/detect-wagtail)
## npm package
```js
const { detectWagtail, renditions } = require('detect-wagtail');
// Example HTML string that may contain Wagtail image renditions
const htmlContent = `
`;
// Use the default strict pattern to check for Wagtail markup
if (detectWagtail(htmlContent)) {
console.log('Wagtail detected!');
}
```
The `renditions` object also directly exposes 5 regular expressions depending on how strict or lax the matching should be:
- `strict`: Optimized for real-world relevance, minimizing false positives.
- `less_strict_but_long`: A bit looser than strict, capturing additional cases.
- `strictest`: Very specific matching with no avoidable false positives.
- `lax`: Looser matching that may yield more false positives.
- `laxest`: The most lenient pattern based solely on rendition suffixes or the original_images folder.
```js
if (renditions.lax.test(htmlContent)) {
console.log('Detected potential Wagtail markup (using lax matching).');
}
```
## How it works
Full read: [Detecting Wagtail in the wild](https://thib.me/detecting-wagtail-in-the-wild).
This uses regular expressions to check whether images on the page match a predetermined pattern:
[](https://regexper.com/#%5C%2F%28original_images%5C%2F%5B%5Cw-%5D%2B%5C.%7Cimages%5C%2F%5B%5Cw-.%5D%2B%5C.%28%28fill%7Cmax%7Cmin%7Cwidth%7Cheight%7Cscale%29-%5Cd%7Coriginal%29%29)
We also check whether the rich text content on the page matches how Wagtail stores this data.
There can be [false positives](https://en.wikipedia.org/wiki/Precision_and_recall) with such simple checks, but they have the benefit of working regardless of whether the target site is directly served by Wagtail, or if Wagtail is used as a headless CMS.
## Related links
- [Detecting Wagtail in the wild](https://thib.me/detecting-wagtail-in-the-wild)
- [Wappalyzer](https://www.wappalyzer.com/technologies/cms/wagtail/)
- [WhatCMS.org](https://whatcms.org/c/Wagtail)
- [detect-django-version](https://github.com/caioariede/detect-django-version)
- [Use consistent heuristics to tell if a site is made with Wagtail](https://github.com/springload/madewithwagtail/issues/62)
## Contributing
```sh
git clone [email protected]:thibaudcolas/detect-wagtail.git
cd detect-wagtail
nvm use
npm install
npm run test
npm install netlify-cli -g
netlify dev
```