Quickstart
Clone this template and publish your docs in five minutes.
This page walks through t urning the starter into your own docs site.
Prerequisites
- A GitHub account.
- A Bloques account.
Set up your site
Create a repo from the template
From the starter repo on GitHub, select Use this template and create a new repository under your account or organization.
Connect Bloques
Sign in to Bloques, create a site, and connect your new repository. Pick the branch to publish from — every push to that branch redeploys the site.
Edit content
Edit pages in the Bloques editor in your browser, or edit .mdx files
directly on GitHub. Saved changes commit to your repo and trigger a deploy.
The first deploy starts as soon as the repository is connected. The build takes about a minute.
Make it yours
Pages live as .mdx files at the root of the repo. The docs.json file controls the site name, navigation, and theme.
Rename the site
Open docs.json and update name and description.
Replace the pages
Edit index.mdx, quickstart.mdx, and the files under essentials/ and
configuration/ with your own content.
Update the navigation
Edit the navigation array in docs.json to match your page structure. See
Navigation.
Set the theme
Pick a preset and an optional primary color in the theme block. See
Theme.