Package deep links: let readers try your Vale style guide in one click

You publish a Vale package. Someone finds it on GitHub, reads the rules, and still has to install Vale, fetch the package, and wire up a config file before they can lint a single paragraph. That gap costs you adopters.

ProseLint Web v1.1.1 closes it with package deep links. Append a query parameter to the editor URL and the visitor lands with your style guide loaded, ready to lint. No CLI, no local setup, no account.

How the links work

Use package for one style guide:

https://proselintweb.com/editor?package=Google

Use packages when you want several at once. Separate names with commas:

https://proselintweb.com/editor?packages=Google,write-good

Package names match the catalog in ProseLint Web. Spelling is flexible: google resolves to Google the same way Google does. If you repeat a name, we deduplicate it.

When someone opens a fresh editor through one of these links, we load the requested package, drop in sample text when the editor is empty, and run lint automatically so they see your rules in action right away. If they already have their own draft in the editor, we leave their text alone and only change the active packages.

Linting still runs entirely in the browser. Their document never uploads to our servers.

Add a badge to your README

Package maintainers asked for a simple way to point readers at a live demo. We ship an SVG badge you can drop into any Markdown README:

[![Try live on proselintweb](https://proselintweb.com/badges/open-in-proselint.svg)](https://proselintweb.com/editor?package=YourPackageName)

Replace YourPackageName with the exact name from the ProseLint Web package catalog. For a package published as write-good, the link becomes:

[![Try live on proselintweb](https://proselintweb.com/badges/open-in-proselint.svg)](https://proselintweb.com/editor?package=write-good)

How it renders

On GitHub, GitLab, or any Markdown viewer that supports linked images, that snippet shows as a clickable badge like this:

The badge reads Try live on proselintweb with a split emerald layout: darker green for the VA logo on the left, lighter green for the label on the right. Clicking it opens https://proselintweb.com/editor?package=Google with the Google package loaded. Readers can paste their own Markdown, HTML, MDX, or AsciiDoc and watch your rules fire on real prose within seconds.

What happens when packages are already loaded

Deep links behave sensibly when the editor is not empty.

If the requested package is already active, we skip the download step and lint with what is loaded.

If the visitor has other packages selected, we show a short prompt: Add to current packages keeps everything they had and layers yours on top. Load only swaps to just the packages from the link. Cancel leaves their setup unchanged.

If the URL names a package we do not carry, we explain that it is missing from the catalog and offer a path to browse what is available.

After we handle the link, we strip the query string from the address bar so bookmarks and shared URLs stay clean.

Who this helps

Vale package authors. Your README becomes a working demo, not just a list of YAML files. Contributors can sanity-check a rule change against sample text before they clone the repo.

Documentation teams. Send a new hire a link like https://proselintweb.com/editor?package=Microsoft instead of a setup doc. They lint on day one.

Style guide champions. Pair a company package with a general checker: https://proselintweb.com/editor?packages=Google,alex loads Google's developer rules alongside alex's inclusive-language checks in one session.

Conference talks and blog posts. Drop a deep link in your slides or article so the audience follows along in the same environment you used on stage.

Try it now

Open the editor with Google loaded or Google and write-good together.

If you maintain a Vale package, add the badge to your README and tell us how it goes. We built this feature so more writers encounter your rules before they decide whether Vale is worth the install. A one-click demo makes that decision easier.