Contributing to Static Website Toolkit

Thank you for your interest in contributing to the Static Website Toolkit! 🎉

This is an open, community-curated collection of tools, services, and resources that help people build, host, and enhance static websites with HTML, CSS, and JavaScript. Every contribution—whether adding a new tool, fixing a broken link, or suggesting a new category—helps keep this resource accurate and valuable for everyone.

Ways to Contribute
Submission Guidelines
Entry Format & Template
How to Submit a Pull Request
How to Submit via an Issue
Pull Request Checklist
License

Ways to Contribute

You can help improve this list in several ways:

Add a new tool: Introduce a service or tool that helps static websites operate without a traditional CMS or dedicated backend.
Suggest a new category: If you know of valuable tools that don't fit into existing sections (e.g., Auth, A/B Testing, Video Hosting), suggest a new category.
Fix outdated entries: Report or fix broken links, outdated descriptions, pricing model changes, or discontinued services.
Share open-source / free alternatives: We love highlighting accessible, privacy-respecting, and open-source solutions.
Improve documentation: Refine descriptions for clarity and accuracy.

Submission Guidelines

To keep this collection high-quality, practical, and spam-free, please adhere to these guidelines:

1. Relevance

The tool must directly benefit static HTML, CSS, and JavaScript websites or Jamstack/frontend architectures.
It should enable features typically requiring a backend (e.g., forms, comments, payments, search, auth) via APIs, widgets, edge functions, or client-side scripts.
General web tools that are not particularly relevant to static site development may be declined.

2. Zero Advertising & No Affiliate Links

Zero advertisement and no affiliate links are allowed.
Always link directly to the official website or official repository using clean, secure HTTPS URLs.
Submissions containing sponsored promotions, advertisements, referral parameters, or affiliate tags will be rejected immediately.

3. Clear, Objective Descriptions

Write a concise, one-sentence description explaining what the tool does, not how great it is.
Avoid marketing hype, buzzwords, or unverified claims (e.g., avoid "The #1 blazing-fast ultimate solution").
Good example: Static search indexing designed for static websites
Bad example: The best, most powerful search engine on the planet!

4. No Duplicates

Before submitting, search README.md (Ctrl+F or Cmd+F) to verify that the tool has not already been listed under another category.

5. Transparency & Affiliation

Creators and maintainers are welcome to submit their own tools!
Please be transparent if you are affiliated with the product or service you are submitting.
Submissions must prioritize usefulness to the community over advertising or self-promotion.

Entry Format & Template

All tools in README.md are organized in full-width tables (<table width="100%">) with four columns: Tool, Description, Pricing / License, and Website.

External links use HTML anchor tags formatted with target="_blank" rel="noopener noreferrer".

Template:

  <tr>
    <td><a href="category-folder/tool-name.md">Tool Name</a></td>
    <td>Clear one-sentence description of what it does.</td>
    <td><img src="https://img.shields.io/badge/Pricing-Color?style=flat-square" alt="Pricing"></td>
    <td><a href="https://example.com/" target="_blank" rel="noopener noreferrer">example.com</a></td>
  </tr>

Example:

  <tr>
    <td><a href="search/pagefind.md">Pagefind</a></td>
    <td>Static search indexing designed for static websites</td>
    <td><img src="https://img.shields.io/badge/Open_Source-238636?style=flat-square" alt="Open Source"></td>
    <td><a href="https://pagefind.app/" target="_blank" rel="noopener noreferrer">pagefind.app</a></td>
  </tr>

How to Submit a Pull Request

If you are comfortable using Git and GitHub:

Fork the Repository: Click the Fork button at the top right of this repository to create your own copy.

Clone your Fork:

git clone https://github.com/<your-username>/htmlstatic.git
cd htmlstatic

Create a Feature Branch:
```
git checkout -b add-tool-name
```
Edit README.md:
- Locate the most relevant category table.
- Insert your new entry following the Entry Format.
- Ensure the table syntax remains properly aligned and valid markdown.
Commit your Changes: Write a clear, descriptive commit message:
```
git commit -m "Add ToolName to Contact Forms category"
```
Push to GitHub:
```
git push origin add-tool-name
```
Open a Pull Request:
- Go to your fork on GitHub and click Compare & pull request.
- Provide a brief description explaining what the tool is and why it belongs in this collection.
- Submit the PR for review!

How to Submit via an Issue (Recommended)

Submitting via GitHub Issues is the quickest and easiest way to propose a tool, service, or resource:

Go to the GitHub Issues Section and click New Issue.
Select the Submit a Tool or Site template.
Fill out the form fields:
- Tool or Site Name: Official name
- Official Website URL: Clean HTTPS link (no tracking or affiliate codes)
- Category: Select the best category match (or suggest a new one)
- Short Description: One objective sentence explaining what it does
Submit the issue! Once the site is verified, it will be added to README.md.

Pull Request Checklist

Before opening your pull request, please make sure:

The tool is relevant to static websites and frontend development.
You searched README.md to ensure it is not already listed.
Zero advertisement and no affiliate links (official HTTPS URL with no tracking/referral parameters).
The description is concise, objective, and one sentence long.
The entry follows the table format with target="_blank" rel="noopener noreferrer".
All existing tables and markdown formatting remain valid.

License

By contributing to this repository, you agree that your contributions will be licensed under the Creative Commons Zero (CC0 1.0 Universal) Public Domain Dedication.

Contributing Guide