Skip to main content

For your AI and the curious

How a SiteShip site is put together

A SiteShip site is a folder of plain files. This page lists them, what each one is for, and what SiteShip writes for you.

On this page

A SiteShip site is a folder of plain files: HTML pages with Liquid templating, Markdown, Tailwind classes, JSON lists and one YAML settings file. SiteShip renders them on each request. There is no build step to run.

Your AI reads the same rules from the connector's guide tool. This page is that guide's architecture topic, shortened for people.

The file tree

data/site.yaml               name, menu, phone, address, hours
data/<list>.json             lists: services, team, FAQ, prices
data/forms/<id>.json         optional: who gets a form's leads
data/redirects.json          redirects
templates/layout.html        header, {{ content }}, footer
templates/components/*.html  partials: header, footer, your own
pages/index.html             /
pages/about.html             /about
pages/services/index.html    /services
pages/services/[slug].html   /services/<slug>, a page per item
pages/blog/*.md              Markdown posts
theme.css                    design tokens (@theme)
assets/images|files|js/      images, downloads, scripts

Pages

A page is frontmatter plus the content that goes inside <main>. It has no <html>, <head>, <body>, header or footer.

---
title: Teeth Whitening
description: Whitening in one visit, from $299. Book online.
image: /assets/images/whitening.jpg
---
<section class="py-20">
  <h1 class="text-4xl font-bold">Teeth Whitening</h1>
</section>

Frontmatter is YAML. A colon inside an unquoted value is a YAML error and the file is refused, so quote such values: title: "Services: What We Do".

Pages can also be Markdown (pages/about.md). Liquid works in Markdown pages too, except inside code blocks, which print as written.

Layouts and partials

Every page uses templates/layout.html unless one of these applies. The first match wins:

Page Layout used
Markdown files in pages/<dir>/ templates/<dir>/single.html
pages/<dir>/index.html templates/<dir>/archive.html
Any page with layout: name in its frontmatter templates/name.html

There is no {% extends %}. Shared pieces are partials in templates/components/, rendered by bare name:

{% render 'header' %}
{% render 'service-card', service: s %}

A partial always sees site, data, page, params, item, year, currentPath and canonicalUrl. Pass anything else as an argument.

Lists and a page per item

Anything there is more than one of is a JSON file in data/, read as data.<list> in a loop.

[{ "slug": "whitening", "name": "Teeth Whitening", "summary": "Whiter teeth in one visit.", "price": "$299" }]
{% for s in data.services %}<a href="{{ s.url }}">{{ s.name }}</a>{% endfor %}

Write pages/services/[slug].html and each item gets a page at /services/<slug>, with the item as item. The folder name ties the page to data/services.json. An address that is not in the data is a 404.

Styling

Styling is Tailwind v4 utility classes in the markup. Brand colours and fonts are tokens in theme.css, and each token makes classes:

@theme {
  --color-primary-600: #0f766e;   /* bg-primary-600, text-primary-600 … */
  --font-display: "Fraunces", serif;
}

What SiteShip writes for you

These are not files in the site. SiteShip makes them on every page, from the frontmatter and data/site.yaml:

  • The document and its head: doctype, <html lang>, charset, viewport, <title>, description, canonical link, robots, Open Graph and Twitter tags, the favicon and the stylesheet link.
  • The tab title, as "Page | Site". The home page shows the site name alone.
  • Schema.org data: Organization and WebPage on every page, LocalBusiness on the home page, BreadcrumbList on inner pages, Article on dated Markdown posts, and FAQPage on a page with type: faq.
  • /sitemap.xml, /robots.txt, /feed.xml and tag pages.
  • /search and /search.json, over page titles, descriptions, keywords and page text.
  • 404 pages for unknown addresses.
  • The compiled CSS. Preview and publish compile it.
  • Form handling: the submit script, spam protection, storage and email.
  • Lazy loading for images, and the script for menus, tabs, dialogs and filters, added only on pages that use them.

A hand-written copy of a head tag in a layout or partial is dropped and reported as author.engine_head_tag. templates/components/head.html is for extras only: a font <link>, a verification tag, a third-party head script.

Business facts in one file

The name, phone, email, address, hours, menu, logo and social links live in data/site.yaml. Templates print them, for example {{ site.phone }}. They are never typed into a page.

name: Harbor Dental
description: Family and cosmetic dentistry in Mount Pleasant, SC
businessType: Dentist
phone: "(843) 555-0100"
email: hello@harbordental.com
address:
  street: 123 Coleman Blvd
  city: Mount Pleasant
  state: SC
  zip: "29464"
hours: "Mon-Thu 8am-5pm; Fri 8am-1pm; Sat-Sun closed"
menu:
  - { label: Services, url: /services }
  - { label: Contact, url: /contact }

Because every page and the schema read the same file, a changed phone number changes everywhere at once. Any field you add yourself is available as site.yourfield.

Redirects

data/redirects.json is a list of rules:

[
  { "from": "/old-page", "to": "/new-page" },
  { "from": "/blog/*", "to": "/news/:splat" },
  { "from": "/p/:slug", "to": "/services/:slug", "status": 302 }
]

A rule is a 301 unless status says otherwise. Use them when a page moves, and for the addresses of a site you moved to SiteShip.

Scheduling and drafts

Three frontmatter fields control when a page shows:

Field What it does
publishDate: 2026-12-01 Hides the page until that day. It is left out of listings, the feed and the sitemap until then.
draft: true Keeps the page off the site until you remove the line.
date: 2026-11-16 Sorts posts and shows on them. It never hides a page.

These are separate from the site's draft. Every change, whatever it is, waits in the site's draft until the owner publishes. See Drafts and previews.

Not supported

Each of these is refused or reported when the file is written, with the fix.

Not supported Use
<style> blocks and style="" attributes Tailwind classes in the markup
@apply, component classes and @import in theme.css A partial for repeated markup; font links in head.html
Bootstrap or another stylesheet Tailwind classes
Alpine.js (x-data, @click): author.alpine_unsupported data-open, data-tabs, <details>, <dialog>, or plain JavaScript in assets/js/
Bootstrap's data-toggle: author.bootstrap_toggle data-open or <details>
<input type="file"> in a form: author.form_file_input A link to a hosted upload form
<input type="password"> in a form: author.form_password_input A link to the service that runs the login
A form with its own submit handler: author.form_custom_submit A plain form that posts to /api/forms/<id>; SiteShip submits it
A hand-written <head>, <title> or meta tag: author.engine_head_tag Frontmatter and data/site.yaml
{% extends %} Partials

For why the engine works this way, see The engine.

Something wrong on this page? Email support@siteship.ai. Checked on November 13, 2026.

Built in a chat

Home page of Low Tide Coffee, a coffee shop website built with SiteShip

Coffee shop

Low Tide Coffee

The prompt that built it

Build a website for Low Tide Coffee, a small coffee shop and roastery at 14 Harbor Street, Beaufort, SC. We roast our own beans in the back room. Open every day 7am to 3pm. Phone (843) 555-0114. A menu with prices (drip, cortado, cold brew, oat-milk latte, biscuits and pastries). Two house blends sold in the shop: Marsh Blend and Dock Street Dark. Catering for offices and events, with an enquiry form (name, email, date, number of people, message). Pages: Home, Menu, Our beans, Catering. Look: warm and moody. Dark roasted brown and cream with a burnt-orange accent, an elegant serif for headlines with a clean sans for text, a photo of coffee being poured in the hero, and a menu laid out like a printed cafe menu.

Swap in your own business details. Your AI will ask five quick questions if anything is missing.

Add SiteShip to your AI

SiteShip is a connector you add once. You'll create your free account when you connect. No card needed.

https://app.siteship.ai/mcp
ChatGPT
  1. Open ChatGPT on the web and go to Settings, then Apps and connectors.
  2. Choose Add custom connector (you may need to switch on Developer mode under Advanced).
  3. Name it SiteShip, paste the address above and choose OAuth.
  4. Sign in to SiteShip when asked, then start a new chat and say: Get started with SiteShip.

Custom connectors need a paid ChatGPT plan.

Claude
Add to Claude

This opens Claude with SiteShip filled in. Click Add, sign in to SiteShip, then say: Get started with SiteShip.

Or add it by hand

  1. Open Claude and go to Customize, then Connectors.
  2. Click Add, then Add custom connector.
  3. Name it SiteShip and paste the address above.
  4. Sign in to SiteShip when asked, then start a new chat and say: Get started with SiteShip.
Grok

Go to grok.com/connectors, choose New Connector, then Custom, and paste the address above.

Gemini

In the Gemini web app, open Apps/Connectors settings, add a custom connector and paste the address above. (US accounts only for now.)

Other AI apps and coding tools
  1. Open your AI app's settings and look for Connectors, Apps, Integrations or MCP servers.
  2. Add a custom (remote) connector and paste the address above.
  3. Sign in to SiteShip when asked, then start a new chat and say: Get started with SiteShip.

Works with any app that accepts a remote MCP server, including coding tools such as Claude Code, Cursor, VS Code and Codex.

Coding tools

Claude Code

claude mcp add --transport http siteship https://app.siteship.ai/mcp

Codex

codex mcp add siteship --url https://app.siteship.ai/mcp

Then say: Get started with SiteShip.