Kendi documentation — Next.js
Everything you need to take Kendi for Next.js 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 |
What is in the package
Section titled “What is in the package”- 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.
- Home, About, Articles (
- 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), with a server action each and four ways to deliver them (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.xmlandrobots.txt. - Placeholders: the photos in
public/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.mdandLICENSE.md.
In a hurry: the first 15 minutes
Section titled “In a hurry: the first 15 minutes”npm installnpm run dev- Open http://localhost:3000.
- Put your magazine’s name, title, description and domain in
src/content/site.ts, and your menu, e-mail, phone, address, social links, sidebar texts and footer in the same file. - Replace the images in
public/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). - Replace the logo
public/images/logo.svg(Making it look like your brand), the browser icons insrc/app/(icon.svg,apple-icon.png) and the share image (public/opengraph-image.png). - Write your posts, categories and authors in
src/content/collections/, and the page copy insrc/content/pages/. Search for “Kendi”: the demo’s magazine is named in several places. - Fill in the placeholders of the legal pages (
[Your Company Name],[URL]…) insrc/content/collections/legal.ts(Editing the content), and replace the sample ad (Editing the content). - Point the forms at your inbox or newsletter tool: Forms.
- Deploy: Going live.
Nothing else is required: the site has no database, no account to create and no paid service to run.
How this template is put together
Section titled “How this template is put together”- Content is data. All text and every collection item live in
src/content/. Pages read the collections throughsrc/lib/content.ts, which is why swapping in a CMS later touches one file, not the whole site. - Design is tokens. Colours, breakpoints and easing curves are in
src/design-system/theme.css; text styles and springs insrc/design-system/tokens/. Change a token and every page follows (Making it look like your brand). - Components are shared. Every button, card, form field and section is in
src/design-system/orsrc/components/, and is shown at/style-guideon 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).
Getting help
Section titled “Getting help”- Your licence terms: License.
- What changed in each release: Changelog.
- Support and updates: https://framebrick.co/support.
- Want it done for you? Marcframe, the studio behind this template, updates templates to your needs, builds custom templates and designs new sites. It’s also on Contra.