Open source maintainers

Docs online without a Pages workflow.

Documentation generators produce static HTML, and putting that HTML somewhere shouldn't need a branch, a workflow file, and a repository setting. Point the CLI at the output folder, or deploy it from CI with the Action.

when it comes up

Where maintainers reach for this

  • Docs for a project that isn't on GitHub

    GitHub Pages needs a GitHub repo. A project on GitLab, on Codeberg, or on a machine of yours still has docs that need an address.

  • A demo page for the library

    A page that loads your built bundle and shows the thing working, deployed straight out of the examples folder rather than embedded in a README.

  • Previewing a docs contribution

    Deploy a contributor's build to its own address so a reviewer reads the rendered page instead of guessing at the diff.

how it goes

From a folder to a link

  1. 01

    Generate the docs

    Whatever the generator is, its output folder is the deployable thing — harvis can't tell one generator's HTML from another's.

  2. 02

    Deploy it

    npx harvis deploy site, or the GitHub Action as a step in the release workflow you already run on tags.

  3. 03

    Keep the address stable

    Replacing an existing site swaps its files without changing the URL, so the docs link in your README stays correct across every release.

ways in

Pick how you drive it

All of these publish the same way and produce the same site. The only difference is what you already have open.

Put something online and see

The first deploy needs no account: drop a folder in and a live URL comes back, along with a private claim link if you decide to keep the site.

Put a site online

Questions from maintainers

Why not just use GitHub Pages?

If the project is on GitHub and the Pages workflow already works, keep it. This is for the cases where it doesn't — a project hosted elsewhere, docs you'd rather not commit to the repo, or a preview that shouldn't touch the repo at all.

Can contributors deploy previews without access to my account?

Not to your sites — replacing an existing site needs your API key, so previews from a fork are yours to run. A contributor can always deploy their own build anonymously and send you that link, since the first deploy needs no account.

Can I script a separate docs site per version?

Yes. Each version is its own site, one API key covers all of them, and the HTTP API's OpenAPI contract is published — so listing, creating, and replacing them is a short script rather than an integration.

Do I need an account?

Not for the first deploy. You get a live URL and a private claim link; the claim link attaches the site to a free account when you want to choose its subdomain, redeploy over it, or delete it.

What can harvis not host?

Anything that needs code running on a server: PHP, Node, Python, a database, or a page rendered at request time. harvis serves the static files you upload and collects submissions from forms on them. A JavaScript front end talking to an API hosted elsewhere works normally.

What does it cost?

Publishing is free — 500 files and 50 MB per site, no card, and sites that do not expire. If a month outgrows the free limits the account steps onto the nearest paid step, from $5, and steps back down when usage does. Bandwidth and SSL are never billed.

other use cases

Is someone else's job closer to yours?

The product underneath is the same — these pages just start from a different problem.