Skip to content

Style architecture.md with a Jekyll layout + prose CSS#15

Merged
rodrigobnogueira merged 1 commit into
mainfrom
chore/architecture-page-layout
May 25, 2026
Merged

Style architecture.md with a Jekyll layout + prose CSS#15
rodrigobnogueira merged 1 commit into
mainfrom
chore/architecture-page-layout

Conversation

@rodrigobnogueira
Copy link
Copy Markdown
Contributor

Summary

  • The architecture page at https://nest-native.dev/reference-app/architecture.html was rendering as a raw markdown body with no <html>/<head>, no stylesheet link, and no typography. This PR adds a Jekyll layout + prose styling so it matches the splash page.

Changes

  • docs/_layouts/default.html — minimal site chrome (header + footer mirroring docs/index.html), <link rel="stylesheet" href="…/styles.css">, <main><article class="prose">{{ content }}</article>. Per-page <title> falls back to the site title. Uses relative_url so the page works under the /reference-app/ baseurl.
  • docs/architecture.md — adds front matter (layout: default, title, description) so Jekyll wraps it in the layout.
  • docs/styles.css — appends a .prose block (~180 lines) covering the markdown surface area in this app: heading scale + section dividers, link underline, inline code, <pre> + rouge-wrapped code blocks, tables (with hover + responsive horizontal scroll), blockquotes, <hr>, lists with accent markers.

docs/index.html stays a complete document with no front matter — Jekyll passes it through unchanged.

Modules Touched

  • Tooling / CI / docs only

Public Surface (libraries)

  • No use of library internals introduced.

Security Review

  • Static HTML/CSS only. No scripts, no forms, no user input.
  • No new dependencies (Jekyll/kramdown/rouge run server-side on GitHub Pages).
  • No secrets in markup or comments.
  • No unresolved high-risk security finding remains.

Dependency Review

  • No dependency or lockfile changes.

Migrations

  • No schema changes.

Validation

  • npm run ci unaffected (docs-only).
  • Live render — verified after merge when GitHub Pages rebuilds.

Release Notes

  • No release impact
  • Release impact: visual fix only; user-visible at nest-native.dev/reference-app/architecture.html.

The architecture page was being rendered by Jekyll as raw HTML body —
no head/header/footer, no stylesheet link, no typography styling. Add:

- docs/_layouts/default.html: site chrome + <link rel=stylesheet> + a
  <main><article class=prose>{{ content }}</article> wrapper. Same
  header/footer as the splash page, plus a per-page <title>.
- Front matter on docs/architecture.md so it picks up the layout.
- A .prose block in styles.css with markdown typography that matches
  the dark theme: heading scale + section dividers, prose link
  underline, code + pre styles (rouge-friendly), tables, blockquote,
  hr, lists, responsive table scroll.

index.html is a complete document and keeps rendering as-is — only
markdown pages opt into the layout via front matter.
@rodrigobnogueira rodrigobnogueira merged commit 102cdcd into main May 25, 2026
2 checks passed
rodrigobnogueira added a commit that referenced this pull request May 25, 2026
Style architecture.md with a Jekyll layout + prose CSS
@rodrigobnogueira rodrigobnogueira deleted the chore/architecture-page-layout branch May 25, 2026 11:49
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