Quickstart
Get from zero to a live docs site in under five minutes.
Prerequisites
- A GitHub account.
- A repository where the Bloques GitHub App can be installed, or permission to create one. The repository can be empty.
- A Bloques account. Sign-in is a magic link sent to your email.
Create your project
Sign in to Bloques
Open the Bloques sign-in page. Enter your email and select Continue with email. Open the magic link from your inbox to finish signing in.
Create an organization
Enter a name for your organization and a URL slug. The slug becomes part of your dashboard URL and must be unique. Select Create.
Create a site
Enter a site name and a subdomain. The subdomain becomes your site's public address at <slug>.bloques.site. Select Create site.
Connect your GitHub repository
Install the GitHub App
On the repository settings screen, select Connect Github. GitHub opens in a new tab to authorize the Bloques GitHub App. Grant access to the organization or account that owns the repository.
Select the repository
Back in Bloques, pick the GitHub owner and then the repository to connect. An empty repository is fine — Bloques writes the starter files on the first deploy.
Choose the publishing branch
Pick the branch to publish from. Every push to this branch redeploys the site. Select Save changes.
See your site live
The first deploy starts as soon as the repository is connected. Wait for the deployment status to turn green in the dashboard — the first build takes about a minute.
Open <slug>.bloques.site in a new tab. The starter site is live.
Replace <slug> with the subdomain chosen during site creation.