Doc Site Using MkDocs¶

Welcome to the first project in my Docs‑as‑Code Portfolio Series, where I’m building and publishing documentation sites using four different static site generators (SSGs): MkDocs, Hugo, Docusaurus, and Jekyll.

This repo represents my work with MkDocs and demonstrates how I approach modern documentation workflows—from information architecture and content strategy to build automation and publishing.

🎯 Purpose of This Project¶

As a Sr. Technical Writer, I use git‑based workflows and developer‑centric tooling.

This portfolio series is my opportunity to:

Strengthen and demonstrate my docs‑as‑code skills
Explore and compare popular SSGs used in engineering teams
Showcase real examples of my technical writing
Build documentation sites end‑to‑end using best practices
Create a curated, public‑facing writing and tooling portfolio

⚙️ What I Built Using MkDocs¶

🔧 Workflow & Architecture¶

Authored content in Markdown, with support from Material‑enhanced formatting
Structured the site using mkdocs.yml for navigation, metadata, and hierarchy
Applied Material for MkDocs for a polished, professional UI/UX
Leveraged Markdown extensions (admonitions, code highlighting, callouts)
Organized content into clear sections: user guides, APIs, how‑tos, and reference docs

🚀 Build & Delivery¶

Local development with mkdocs serve
Production builds using mkdocs build
Deployed to GitHub Pages with automated publishing
Integrated “Edit on GitHub” and source metadata for easy doc contribution
Optimized navigation and search using Material‑native features

📚 Organized Documentation Examples¶

These examples demonstrate structured, audience‑focused documentation across multiple content types:

🧱 Tech Stack¶

MkDocs for static generation (Markdown‑based)
Material for MkDocs for UI, extensions, and enhanced navigation
YAML‑driven configuration via mkdocs.yml
GitHub Pages for hosting
Python tooling (mkdocs, theme plugins, Markdown extensions)

Source & CI:
Repository · Actions