This repository contains the source code for the Yaama Tech website. The website is built using Docusaurus, a modern static website generator optimized for technical and documentation websites.
The source code is available under the src directory, which contains:
docs/: Documentation content in Markdown/MDX formatblog/: Blog posts in Markdown/MDX formatsrc/: Custom React components and pagesstatic/: Static assets like imagesdocusaurus.config.ts: Main configuration filesidebars.ts: Sidebar configuration for documentation
- Install dependencies:
npm install- Start the development server:
npm start- Build for production:
npm run buildIn order to create a blog post using CursorMail I paste the following template into the chat area and fill in the blanks.
Create a new blog post placeholder, with following details using @blog-posts.mdc rules:
Author:
Slug:
Date:
Title:
Description:
Keywords:
Tags:
Example:
Create a new blog post placeholder, with following details using @blog-posts.mdc rules:
Author:
yaama
Slug:
remote-but-ready-how-to-impress-in-your-next-offshore-interview
Date:
24 April 2025
Title:
Remote But Ready: How to Impress in Your Next Offshore Interview
Description:
Prepare for offshore interviews by mastering tech tools, understanding cultural nuances, and showcasing your remote work skills for success.
Keywords:
offshore interview, remote work, cultural understanding, technical readiness, interview preparation
Tags:
offshore-interview, remote-work, interview
To create a new blog post:
-
First, ensure you're added as an author in
src/blog/authors.yml:your_name: name: Your Full Name title: Your Role url: https://github.com/yourusername image_url: https://github.com/yourusername.png page: true # Optional: set to true if you want an author page socials: github: yourusername x: yourhandle # Optional linkedin: yourprofile # Optional
-
If you're using new tags, define them in
src/blog/tags.yml:your_tag: label: Your Tag Label permalink: /your-tag description: Description of what this tag represents
-
Create your blog post in one of two ways:
a. For posts without images:
- Create a file named
YYYY-MM-DD-title.mdin theblogdirectory - Example:
2024-03-20-introducing-yaama.md
b. For posts with images:
- Create a new directory in
blognamedYYYY-MM-DD-title - Place an
index.mdfile inside this directory - Put all related images in the same directory
- Example structure:
blog/ └── 2024-03-20-introducing-yaama/ ├── index.md ├── demo.png └── architecture.png
- Create a file named
-
Add the required front matter at the top of your file:
--- title: Your Blog Post Title description: A brief description of your post slug: your-custom-url-slug authors: [your_name] # Must match your ID in authors.yml tags: [your_tag] # Must be defined in tags.yml ---
-
Write your blog content in Markdown/MDX format below the front matter.
-
To create a post summary, add the
<!-- truncate -->marker after your introduction:This is my introduction that will appear in the preview. <!-- truncate --> This is the rest of my post. -
Reference images in your post:
- For posts with a dedicated directory:

- For images in the static directory:

- For posts with a dedicated directory:
The blog post will be automatically added to the website and will be available at http://localhost:3000/blog/your-custom-url-slug when running the development server.
This project is licensed under the MIT License - see the LICENSE file for details.
Contributions are welcome! Please feel free to submit a Pull Request.
When you push a feature branch, it will be automatically deployed to a preview environment. The deployment will be available at:
{branch-name}.yaama-website-v1.pages.dev
For example, if your branch is named feature/contact-us, after 3-5 minutes the deployment will be available at:
feature-contact-us.yaama-website-v1.pages.dev