uBlacklist Website

This repository hosts the website of uBlacklist.

Development

The site is built with Hugo (extended) and the Hextra theme, which is included as a git submodule. Clone with --recurse-submodules or run git submodule update --init.

The scripts require bash >= 4, GNU sed (gsed from Homebrew on macOS), and yq.

hugo server         # local preview (the dev server needs ".html" in typed URLs)
scripts/build.sh    # production build into public/
scripts/generate.sh # regenerate the files derived from languages.yml

Contribution

For bug reports, questions, or suggestions, please visit uBlacklist Discussions. See the contribution guidelines for details.

New Ruleset

To list your ruleset on the Community Rulesets page, please open a Website: New Ruleset discussion.

Note

Whether and when a ruleset is listed is entirely at the maintainer's discretion, and listed entries may be edited or removed at any time without notice.

Translation

Please use Crowdin for all translations.

To add the website in a new language:

1. If your language is not listed on Crowdin, request it there using the "Request New Language" button.
2. Translate at least 60% of the website strings on Crowdin.
3. Open a Website discussion to request that the new language be enabled on the website.