Skip to content
Sign inJoin waitlist

Kendi documentation — Astro

Everything you need to take Kendi for Astro from the downloaded folder to a published blog or magazine. Read in this order, or jump to what you need.

Guide What it covers
Install and run Requirements, install, the commands, what is in each folder
Editing the content Editing text, images, posts, categories, authors, the team, the legal pages and the sponsored ad — no CMS needed
Making it look like your brand Colours, the logo, fonts, text styles, spacing, motion, components, icons, the style guide
Pages and sections The header, the sections of every page with a map of each, adding, removing and reordering pages and sections
Forms Making the contact form and the newsletter deliver to you
Using a headless CMS The collections and their fields, for connecting Sanity, Payload, Strapi, Directus or any other headless CMS
Going live Pre-launch checklist, deploying, domains, what to do after launch
Troubleshooting and questions Errors, questions and answers
  • 11 kinds of page, 86 addresses:
    • Home, About, Articles (/blog), Categories (/category), Authors (/author), Contact and the 404 page;
    • a page for each of the 64 posts, 8 categories, 6 authors and 2 legal pages, built from the collections.
  • 6 collections in src/content/collections/: posts (64), categories (8), authors (6), legal pages (2), the About team (6) and the footer’s photo grid (instagram, 4).
  • 2 forms: the contact form and the newsletter sign-up, which appears in three places (Home’s hero, the sidebar card, the band above the footer), in demo mode out of the box, posting to a form service or webhook from any static host, or delivered by the site’s own route (a log, a webhook, Mailchimp, Resend).
  • Lists that fill themselves: posts sorted by date; Home’s slideshow, Latest posts and the Spotlight take the newest posts, Editor’s pick and Trending the posts you flag, a post’s “Related Post” the newest of its category; Articles loads six posts at a time as the reader scrolls.
  • A sponsored ad slot on Home and in the sidebar, with a sample ad to replace with your own.
  • Motion from the original design (the slideshows, labels that roll up, photos that grow, the Categories menu), with reduced-motion support, and a style guide of every component at /style-guide.
  • Search and sharing: a title, a description and a canonical link for every page, share cards, icons, sitemap.xml and robots.txt.
  • Placeholders: the photos in src/assets/images/ are grey placeholders that show their sizes (the demo uses photos from Unsplash and Pexels, which can’t be sold with a template). The logo is drawn for the template.
  • These docs (docs/), the forms guide (Forms reference), the design system’s reference (Kendi design system), CHANGELOG.md and LICENSE.md.
Terminal window
npm install
npm run dev
  1. Open http://localhost:4321.
  2. Put your magazine’s name, title, description and domain in src/content/site.json, and your menu, e-mail, phone, address, social links, sidebar texts and footer in the same file.
  3. Replace the images in src/assets/images/ (keep the file names and you are done): the post covers, the category photos, the authors, the team, the footer’s photo grid and the sample ad (Editing the content).
  4. Replace the logo src/assets/images/logo.svg (Making it look like your brand), the browser icons in public/ (icon.svg, apple-icon.png) and the share image (public/opengraph-image.png).
  5. Write your posts, categories and authors in src/content/collections/, and the page copy in src/content/pages/. Search for “Kendi”: the demo’s magazine is named in several places.
  6. Fill in the placeholders of the legal pages ([Your Company Name], [URL] …) in src/content/collections/legal.json (Editing the content), and replace the sample ad (Editing the content).
  7. Point the forms at your inbox or newsletter tool: Forms.
  8. Deploy: Going live.

Nothing else is required: the site has no database, no account to create and no paid service to run.

  • Content is data. All text and every collection item live in src/content/. Collections are JSON files checked against src/content/schemas.ts; pages read them through src/lib/content.ts, which is why swapping in a CMS later touches one place, not the whole site.
  • Design is tokens. Colours, breakpoints and easing curves are in src/design-system/theme.css; text styles and springs in src/design-system/tokens/. Change a token and every page follows (Making it look like your brand).
  • No framework in the browser. Pages are static HTML; the menus, slideshows, the loader and the forms are small scripts in src/design-system/scripts/, and hovers are CSS.
  • Components are shared. Every button, card, form field and section is in src/design-system/ or src/components/, and is shown at /style-guide on your own site.
  • Blocks are shared too. The breadcrumb, the sidebar, the newsletter band, the header and the footer appear on many pages from one copy (Pages and sections).