Marai Neesu documentation — Astro
Everything you need to take Marai Neesu for Astro 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 text, images, projects, products, posts, services, testimonials, the CV, the tools and your 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 inquiry 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”- 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 and Products live at
/project,/serviceand/product, in the singular (Pages and sections).
- 8 collections in
src/content/collections/: projects (6), products (6), posts (12), services (4), testimonials (8), the CV’s jobs (experiences, 4), the tools of the Stack (9) and social profiles (4). - 2 forms: the inquiry on Contact and the newsletter sign-up on Blog. They run in demo mode until you give them a destination: a form service or webhook on any static host, or the site’s own route with four ways to deliver (a log, a webhook, Mailchimp, Resend).
- You as the logo: your photo, name and city in the header, which stays at the top of every page; on desktops its background, the logo and the “Contact” button fade away while the visitor scrolls down and come back when they scroll up.
- Motion in the components, with reduced-motion support: hovers, rolling texts, tickers, a slideshow on phones, the
questions and the course modules (Making it look like your brand). 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
src/assets/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 of the Stack, the social icons and the sample client logos ship as they are. - These docs (
docs/), the forms guide (Forms reference), the design system’s reference (Marai Neesu design system),DESIGN.md(the design tokens and rules for AI coding tools),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:4321.
- Put your name, title, description and domain in
src/content/site.json, and yourself as the logo (person), your e-mail, menu, footer and profiles in the same file. - Replace the images in
src/assets/images/(keep the file names and you are done): your portrait and avatar, the photos of the projects, products, posts and services, the testimonials’ portraits and the client logos. - Replace the browser icons in
public/(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, jobs, tools and profiles insrc/content/collections/. Search for “Marai Neesu”, “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/, as JSON. Pages read the collections throughsrc/lib/content.ts, andsrc/content.config.tssays where each collection comes from, which is why swapping in a CMS later touches one file, not the whole site. - Design is tokens. Colours, breakpoints and the tickers’ and the form’s motion 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. - Some blocks repeat. “Work with Me” (Home and Services), the questions (Services and Course) and a few headings appear on several pages; each page’s file holds its own copy, so change it in each (Pages and sections).
- No framework in the browser. The pages are static HTML. Each interactive part has a small TypeScript script in
src/design-system/scripts/(the header’s issrc/components/site/header.ts) whoseinit*()function the component’s<script>calls, and hovers aredata-hover/data-motionattributes played byscripts/hover.ts(Making it look like your brand).
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.