Skip to Content
Get Started

Get Started

Add a page

Create a new .mdx file in the content/ directory:

content/my-page.mdx
# My Page
 
Your content here.

Register it in content/_meta.js to control sidebar order and titles.

Local development

npm install
npm run dev

Open http://localhost:3000  in your browser.

Deploy to GitHub Pages

  1. Create a GitHub repository named hyperreal.
  2. Push this project to the main branch.
  3. In the repository settings, set Pages → Build and deployment → Source to GitHub Actions.
  4. Push to main — the included workflow builds and publishes the static site.

Custom domain

The site is configured to serve from the root of a custom domain, set by public/CNAME. Point the apex domain at GitHub’s Pages IPs, then enable Settings → Pages → Enforce HTTPS.

If you drop the custom domain and go back to USERNAME.github.io/hyperreal/, restore basePath: '/hyperreal' and assetPrefix: '/hyperreal/' in next.config.mjs — without them every asset 404s under the subpath.

Last updated on
Introduction