matuzo / HTMHell

A collection of bad practices in HTML found on real websites.
MIT License
568 stars 67 forks source link

HTMHell - Markup From Hell

A collection of bad practices in HTML, copied from real websites.

https://www.htmhell.dev

Contributing

Rules

Basics

Note: Please ensure you have EditorConfig installed in your editor before contributing any file changes. It'll help us maintain a consistent use of whitespace in this repo's files.

  1. Fork this repo and install the dependencies.

    npm install
  2. Run the project

    npm run start
  3. Take screenshot While the server is still running, run the following command to take a screenshot of your code.

    npm run screenshot
  4. Push and create a pull request.

Adding authors

Add an author in ./hell/_data/authors.js if they're not listed.

{
  "id": "UNIQUE ID",
  "name": "DISPLAY NAME",
  "link": "WEBSITE/TWITTER/GITHUB"
}

Adding a submission

Add a submission in ./hell/entries by copying any other markdown file in this folder.

  1. Show bad code
  2. Explain how to fix it
  3. Show good code

Snippets

I’m afraid that many suggestions will recur. To avoid duplicate content, there’s a file with snippets in hell/_data/snippets.js that you can use like this:

{{ snippets.sr_only }}