https://github.com/jeroen-g/hummingbird
Validate your DOM to be SEO-proof.
https://github.com/jeroen-g/hummingbird
seo seo-analysis seo-tools
Last synced: about 2 months ago
JSON representation
Validate your DOM to be SEO-proof.
- Host: GitHub
- URL: https://github.com/jeroen-g/hummingbird
- Owner: Jeroen-G
- License: mit
- Created: 2021-02-06T22:20:24.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-02-14T18:30:30.000Z (over 4 years ago)
- Last Synced: 2025-03-26T15:48:09.584Z (2 months ago)
- Topics: seo, seo-analysis, seo-tools
- Language: PHP
- Homepage: https://jeroen-g.github.io/Hummingbird/
- Size: 105 KB
- Stars: 12
- Watchers: 1
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- License: LICENSE
Awesome Lists containing this project
README
# Hummingbird
[![CI][ico-pulls]][link-docker]
[![CI][ico-actions]][link-actions]
Validate your DOM to be SEO-proof.
## Quickstart
The best way to use this is by using the Docker container:
```bash
docker run -t --rm jeroeng/hummingbird:v1.0 evaluate:url https://github.com
```
You may replace `dev` with a tagged release number for more stability.
You should run `docker pull jeroeng/hummingbird` to update the container once in a while.
## Usage
### Evaluate URL
```bash
evaluate:url
```
You may give multiple urls, separated by a space.
```bash
evaluate:url github.com enrise.com
```
By default, it will run all assertions. You may pass your preferred set of assertions.
For example, to only test for the h1 and open graph tags:
```bash
evaluate:url github.com -a h1,og
```
## Change log
Please see the [changelog](changelog.md) for more information on what has changed recently.
## Contributing
There is a Makefile in the repository, run `make install` to quickly get started.
After that, to try out any command, do not keep rebuilding the Docker container but instead call the commands like this:
```bash
php bin/console evaluate:url
```
## Credits
- [Jeroen][link-author]
- [All Contributors][link-contributors]
## License
MIT. Please see the [license file](LICENSE) for more information.
[link-docker]: https://hub.docker.com/r/jeroeng/hummingbird
[ico-pulls]: https://img.shields.io/docker/pulls/jeroeng/hummingbird?style=flat-square
[link-actions]: https://github.com/Jeroen-G/Hummingbird/actions
[ico-actions]: https://img.shields.io/github/workflow/status/Jeroen-G/Hummingbird/Main%20CI?style=flat-square
[link-author]: https://github.com/jeroen-g
[link-contributors]: ../../contributors