Marai Neesu documentation — Next.js
Everything you need to take Marai Neesu for Next.js from the downloaded folder to a published portfolio. 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 your details, the page copy, images, projects, products, posts, services, testimonials, experiences, tools and social profiles — no CMS needed |
| Making it look like your brand | Colours, the logo, the font, text styles, spacing, motion, components, 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 sign-up 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”- 13 kinds of page, 33 addresses:
- Home, About, Projects, Services, Course, CV, Products, Blog, Contact and the 404 page;
- a page for each of the 6 projects, 6 products and 12 posts, built from the collections;
- Projects, Services, Products and the Course live at
/project,/service,/productand/course, in the singular (Pages and sections).
- 8 collections in
src/content/collections/: projects (6), products (6), posts (12), services (4), testimonials (8), experiences (4), tools (9) and social profiles (4). - 2 forms: the inquiry on Contact and the newsletter sign-up on the Blog, with a server action each and four ways to deliver them (a log, a webhook, Mailchimp, Resend).
- A fixed header that steps aside on desktop: scrolling down fades its background, the logo and the Contact button and leaves the menu; scrolling up brings them back. On phones a Menu button opens every page.
- Motion copied from the original Framer components: hovers, the rolling roles, the testimonial ticker, the client
logo ticker, the service photos that roll under the pointer, the accordions and the course modules, 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 and screenshots in
public/images/are grey placeholders that show their sizes (the demo uses photos from Unsplash, which can’t be sold with a template). The tool logos, the sample client logos and the social icons ship as they are. - These docs (
docs/), the forms guide (Forms reference), the design system’s reference (Marai Neesu design system),DESIGN.md,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 name, title, description and domain in
site, and your name, city and photo inperson, insrc/content/site.ts; your e-mail, menu and footer are in the same file. - Replace the images in
public/images/(keep the file names and you are done), including your portrait (avatar.png,home-portrait.jpg,about-portrait.jpg). - Replace the browser icons in
src/app/(icon.png,apple-icon.png) and the share image (public/opengraph-image.png). - Edit the page copy in
src/content/pages/, and your projects, products, posts, services, testimonials, experiences, tools and social profiles insrc/content/collections/. Search for “Neesu” and “Dubai”: the demo’s person is named in many places. - Point the two forms at your inbox: 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 and breakpoints 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. - Sections are shared too. The projects, services, products and posts sections serve Home and their own pages, and the questions block serves Services and the Course (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.