How to Contribute

This site is open for contributions. Propose a blog post, fix a typo, or add a page—here’s how.

Check out the repository

Clone the site repository to your machine (the “sandbox”):

git clone https://github.com/smaht-ai/smahtai.github.io.git
cd smahtai.github.io

Install GNU make if needed (e.g. apt install make or brew install make). Then:

make install
make serve

Open http://localhost:4000 to preview. Use make build for a one-off build, make clean to clear output.

Create a branch

Create a new branch with a short, descriptive name (e.g. add-blog-post-xyz or fix-about-typo).

git checkout -b your-branch-name

Add a blog post or a page

Adding a blog post

New file in _posts/: YYYY-MM-DD-your-post-title.md.
Front matter: layout: post, title, date, author, categories, optional image.
Write content in Markdown below the front matter.

Adding or editing a page

Create or edit a .md file (e.g. about.md, contact.md) with layout: page, title, permalink.
To show in the menu, add the page under _config.yml (header_pages and site_map).

Make a pull request

Commit, push your branch, and open a PR against main.

git add .
git commit -m "Add blog post: Your title"
git push origin your-branch-name

On GitHub, go to smaht-ai/smahtai.github.io, use “Compare & pull request”, add a description, and submit.

After your PR is approved

Once merged into main, a GitHub Action builds the site and deploys to GitHub Pages. Your changes go live shortly after.

Workflow and build status: repository Actions tab.

Theme: Analytiq Pages

This site uses Jekyll and the Analytiq Pages Theme for layout, styling, and components. The theme is a separate repo and is included as a dependency.

Theme repo: github.com/analytiq-hub/analytiq-pages-theme
Version is pinned in Gemfile. make install fetches the theme.
To upgrade: edit gem "analytiq-pages-theme" in Gemfile, then run make install.

Content and overrides (_config.yml, _includes/, pages, posts) live here; the theme provides the base.

Additional Details

Add images

Put files under assets/images/ (e.g. assets/images/blog/). Reference as /assets/images/yourfile.png or with relative_url in Liquid.

Create SVG files

Add .svg in assets/images/ or assets/images/blog/. Use viewBox, minimal paths; optional <title>/<desc>. See SVG_STYLING_GUIDE.md.

Excalidraw diagrams

Save .excalidraw in assets/excalidraw/. Embed with excalidraw-static.html include. Use /excalidraw-edit to create or edit in the browser.

Vibe-code with AI editors

Use Cursor, Claude Code, Windsurf, or GitHub Copilot. Point the AI at AGENTS.md and this page; have it draft posts or pages, then review, make serve, and open a PR.

Questions? Contact us or open an issue on the repository.