Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Build & Test Docs Site with CI & HTML Proofer #74

Open
FelicianoTech opened this issue Oct 19, 2019 · 0 comments
Open

Build & Test Docs Site with CI & HTML Proofer #74

FelicianoTech opened this issue Oct 19, 2019 · 0 comments
Labels
enhancement New feature or request

Comments

@FelicianoTech
Copy link
Contributor

Hey,

I'm a big advocate for static docs sites and Hugo in particular (I'm a contributor). I see that this docs site is built with Hugo but not on CI.

I propose that this site gets built on CircleCI, this way PRs can be checked automatically before merging. There's a tool that I've used with Hugo and Jekyll-based websites called HTML Proofer that can test the generated static site for errors. My favorite usecase for it is to check for broken links though it can also check your HTML structure as well to make sure that well formed HTML pages are being generated.

A few examples of how this works:

Feliciano.Tech/config - my personal site, built with Hugo and tested with HTML Proofer
CircleCI Docs/config - CircleCI's documentation website, built with Jekyll and tested with HTML Proofer
Patheon Docs/config - Docs site for Pantheon Hosting, though they're using Gatsby instead of Hugo

I can get a PR going if this sounds good. Just wanted to ask/discuss first.

@senorprogrammer senorprogrammer added the enhancement New feature or request label Nov 12, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Development

No branches or pull requests

2 participants