Skip to content

docs: align user guide styling with the AWS documentation site - #933

Open
bnusunny wants to merge 1 commit into
mainfrom
docs/aws-docs-style
Open

bnusunny wants to merge 1 commit into
mainfrom
docs/aws-docs-style

Conversation

@bnusunny

Copy link
Copy Markdown
Contributor

Summary

Restyles the mdBook user guide (https://aws.github.io/aws-lambda-web-adapter/) to match docs.aws.amazon.com.

  • Theme (docs/guide/theme/custom.css): Cloudscape design tokens used on AWS docs — Amazon Ember font stack, #0f141a text, #006ce0 links, #c6c6cd borders; matching dark (navy) theme. Removes the Google Fonts import.
  • Sidebar: white with dark text, bold blue active page, plain bold section headings, guide title block ("AWS Lambda Web Adapter / User Guide"). Chapter numbering turned off (no-section-label = true). Fixes nested sidebar links all rendering orange.
  • Header: dark top strip, white title bar with bottom border, breadcrumbs above the page title.
  • Alerts: existing > **Note:** / > **Warning:** / > **Important:** blockquotes render as AWS-style alert boxes — no Markdown changes needed.
  • Code blocks & tables: AWS docs styling; smaller headings on narrow screens.
  • New docs/guide/theme/aws-docs.js (loaded via additional-js) adds the guide title, breadcrumbs, and alert classes.

Test plan

  • mdbook build with v0.4.40 (the version pinned in docs.yaml) succeeds with no warnings
  • Visually compared headless Chromium screenshots against a docs.aws.amazon.com page: light theme, navy theme, Note and Warning boxes, mobile width

- Restyle the mdBook theme with Cloudscape design tokens used on docs.aws.amazon.com (typography, colors, sidebar, header, code blocks, tables, light and dark themes)
- Add guide title block, breadcrumbs, and AWS-style Note/Warning/Important alerts via theme/aws-docs.js
- Drop chapter numbering and the Google Fonts import
@bnusunny
bnusunny requested a review from a team as a code owner November 14, 2026 19:52

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant