Hyperclay
  1. Hyperclay
  2. Guide
  3. Quick start

Quick start

Sign up for Hyperclay, start a document from the template gallery, edit it in your workspace, and open its live address.

You can publish an editable document on the web in a few minutes without setting up a local build environment. This guide walks through signing up, starting a document from the gallery, editing it, watching it save, and opening its public address.

Create and publish your first document#

  1. Sign up for an account. Start at Free signup, enter your email address, and open the signup link it sends you. Choose your username and password on the welcome page. A free account holds up to 10 documents. Your username gives you an address namespace at https://<your-username>.hyperclay.com.
  2. Choose a template. Open the template gallery and copy a template into your account. A free account starts with a template and edits it in place.
  3. Open your document. Find the copy in your workspace and open it. With an active Personal or Maker plan, you can also use New document to create a blank document and edit its source in the code editor.
  4. Edit your document and watch it save. Your document opens in view inside the workspace beside your files, the way a visitor sees it. Open the document menu and click Return to editing (or click Edit on the page, or press ⌘⇧E), then click into the page and change some text or add a heading. (If you started an Untitled Document, it renames itself once to match the first heading you type.) While your change writes to the server, the workspace status shows Saving… and clears when the save finishes. Every save in the browser records a snapshot in the document’s Versions panel.
  5. Switch between view and edit. Open the document menu and click View as visitor to see the page without editing controls, as a visitor sees it, and Return to editing to go back. A document you create with New document in the workspace opens straight in edit mode.
  6. Open its live address. Open the document menu and click Open in its own tab (⌘⇧O), or check the Address row in the document’s Info dialog. Public documents are served at https://<your-username>.hyperclay.com/<document-name>.html. Open that address in a private or incognito browser window to see the live, read-only view.

The Journal template carries a Starts private tag and is created as a private document. Only you and people you grant access can open a private document until you open its actions menu and choose Make public.

Where to go next#