AI Engineer Guide

A clean, fast Hugo‑powered blog that powers AIEngineerGuide.com

🚀 Getting Started

Prerequisites

Before you begin, make sure you have these installed:

• Hugo (v0.140.0 or newer)
• Node.js (used for syncing content)

Run Locally

# Clone the repo
git clone https://github.com/AshikNesin/ai-engineer-guide
cd ai-engineer-guide

# Start the dev server
hugo server -t hugo-bearblog

# Or, using Makefile
make dev

# Visit http://localhost:1313 in your browser

🏗️ Site Overview

• Live Site: AIEngineerGuide.com
• Framework: Hugo (static site generator)
• Theme: hugo-bearblog
• Hosting: Netlify + serverless functions
• Content Source: Obsidian vault
• Analytics: Umami integration (self hosted)
• Timezone: Asia/Kolkata

📝 Content Management

How It Works

Content Pipeline

• Source notes live in ~/Sync/Notes/ai-notes/AIEngineerGuide/content/blog/
• Synced via: scripts/sync-obsidian-notes.js
• Output: content/blog/ in Hugo format
• Images: Automatically copied to static/images/

Content is maintained in a separate repo, synced manually when needed.

Sync Commands

# Install sync dependencies
cd scripts && npm install

# One-time sync
cd scripts && npm run sync:once

# Watch for changes
cd scripts && npm run sync:watch

Structure

Posts are grouped by year/month: content/blog/YYYY-MM/

Each post includes:

• Hugo front matter (title, date, tags)
• Markdown content + image links
• Tags

🛠️ Useful Commands

# Start local development server
hugo server -t hugo-bearblog

# Production build
hugo --gc --minify --config hugo.toml

# Clean up build files
hugo --gc

📁 Project Structure

AIEngineerGuide/
├── content/
│   ├── blog/           # Blog posts organized by YYYY-MM
│   ├── bookmarks.md    # Bookmarks page
│   └── newsletter.md   # Newsletter page
├── layouts/            # Custom Hugo layouts
├── static/
│   ├── images/         # Blog post images
│   └── favicon files
├── themes/
│   └── hugo-bearblog/  # Theme directory
├── scripts/            # Content sync automation
├── netlify/
│   └── functions/      # Serverless functions
├── hugo.toml          # Primary Hugo configuration
└── netlify.toml       # Netlify deployment config

🚀 Deploying to Netlify

Settings

• Build Command: hugo --gc --minify --config hugo.toml
• Publish Directory: public/
• Hugo Version: 0.140.0

Environment Variables

Used for 404 tracking:

• PUSHOVER_API_TOKEN
• PUSHOVER_USER_KEY

---

✨ Key Features

• Obsidian Sync: Write in Obsidian, publish with Hugo
• 404 Notifications: Real‑time alerts via Pushover
• RSS Feed: Custom RSS generation
• Analytics: Privacy‑first insights with Umami
• OG Images: Social previews via Cloudinary
• Responsive Design: Mobile‑friendly, clean typography

---

🔧 Customization

Layouts

Override theme templates via layouts/:

• layouts/_default/baseof.html
• layouts/partials/
• layouts/shortcodes/

Serverless Functions

Custom Netlify function for tracking 404s:

• netlify/functions/track-404.mjs
• Sends push alerts for broken links

---

📊 Monitoring

• Umami: Lightweight, privacy‑friendly analytics
• 404 Alerts: Instant detection of broken links
• Build Logs: Netlify deployment feedback

---

📄 License

MIT

🔗 Links

• Hugo Documentation
• Hugo Bearblog Theme
• Netlify Docs