https://github.com/traefik/seo-doc
This program aims to process a documentation folder from traefik/doc and iterate each HTML file adding the requirements for a better SEO
https://github.com/traefik/seo-doc
documentation traefik
Last synced: 4 months ago
JSON representation
This program aims to process a documentation folder from traefik/doc and iterate each HTML file adding the requirements for a better SEO
- Host: GitHub
- URL: https://github.com/traefik/seo-doc
- Owner: traefik
- License: apache-2.0
- Created: 2021-02-09T15:50:34.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-06-23T15:28:01.000Z (12 months ago)
- Last Synced: 2026-01-30T17:47:12.688Z (5 months ago)
- Topics: documentation, traefik
- Language: HTML
- Homepage: https://doc.traefik.io
- Size: 171 KB
- Stars: 3
- Watchers: 5
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
## SEO handler
This program aims to process a documentation folder from [traefik/doc](https://github.com/traefik/doc) and iterate each HTML file adding the requirements for a better SEO.
### The requirements
1. Older doc versions should contain this meta tag:
```html
```
2. Older doc versions should have a canonical link in the head that points to the latest documentation page. Example:
```html
```
3. Titles in older versions should have the Product name and version as a suffix, and should not have more than 65 characters. For example:
```
Overview | Traefik | v2.0
```
4. sitemap.xml and sitemap.xml.gz should not exist under version folders.
### How to use it
You can use the `seo` directly from command line, and using the path to the documentation dir as parameter.
Examples:
```sh
seo -path /path/to/doc/traefik
seo -path /path/to/doc/traefik-mesh
seo -path /path/to/doc/traefik-pilot
seo -path /path/to/doc/traefik-enterprise
```
```sh
seo -path ./site -product traefik
seo -path ./site -product "traefik-mesh"
seo -path ./site -product "traefik-pilot"
seo -path ./site -product "traefik-enterprise"
```