AWS Lambda Boilerplate Docs

This documentation folder contains all content for the AWS Lambda boilerplate project: deployment guides, release notes, and the HonKit book structure with custom dark theme and responsive design.

Contents

Landing Page & Web Presence

A responsive, mobile-first landing page served via Docker/nginx:

  • Location: docker/nginx/index.html
  • Features:
    • Glass-morphism design matching the boilerplate brand
    • Gradient dark background with red accents
    • Responsive grid (3 columns → 2 columns → 1 column on mobile)
    • Navigation links to Documentation, Coverage Report, and Developer Book
    • Quick access backlink to author's personal site
  • Styling: Custom CSS with fluid typography and clamp() for mobile/tablet/desktop scaling
  • Docker: Served via docker/docs.Dockerfile with nginx at localhost:8080

Deployment Guides

Developer Book (HonKit)

Structured technical documentation with dark theme and responsive design:

  • Location: Built to dist/book/ via HonKit
  • Source: Markdown files under docs/ organized by section
  • Styling: Custom dark theme (docs/styles/website.css) inspired by landing page:
    • Gradient dark background matching the brand
    • Glass-morphism panels
    • Red accent colors for consistency
    • Responsive layout for all devices
    • Full-text search via built-in plugin
  • Features: Sidebar navigation, breadcrumbs, search, responsive grid content

Release & Changes

Usage

Viewing Documentation

Local Build

# Build all docs (TypeDoc API reference + HonKit book)
npm run build:docs
npm run build:docs:book

# Open in browser
# - API Docs: dist/docs/index.html
# - Developer Book: dist/book/index.html
# - Coverage: dist/coverage/index.html

# Start the full docs site with landing page at localhost:8080
docker compose -f docker/docker-compose.docs.yaml up

Customizing Documentation

  1. Use guide/deployments/quick-start.md as a quick reference for deploying in the three supported invocation modes.
  2. Refer to guide/deployments/index.md for comprehensive deployment details, local testing, and troubleshooting.
  3. Add new markdown files to docs/guide/ to expand the book structure
  4. Update docs/book.json (HonKit config) if you add new top-level sections
  5. Use styles to match dark theme — CSS is auto-picked from docs/styles/website.css
  6. Keep release notes per version under docs/release-notes/ (named as X.Y.Z.md)
  7. Keep dated change entries under docs/changes-log/ (named as YYYY-mmm-DD.md)
  8. Keep SUMMARY.md in sync with available docs pages for sidebar navigation

Landing Page Customization

The responsive landing page can be customized in docker/nginx/index.html:

  • Logo text: Change the B in .logo to any single character
  • Main heading: Update the <h1> text
  • Subheading & intro paragraphs: Update <p> tags in the header
  • Navigation cards: Add/remove/edit links in .cards-grid section
  • Footer: Update copyright, backlink, and tagline in .page-footer
  • Colors/theme: Override CSS variables in :root block in <style>

After changes, rebuild the Docker image:

docker compose -f docker/docker-compose.docs.yaml build

results matching ""

    No results matching ""