Skip to content

Commit c4b02f2

Browse files
committed
Reskin book with custom Tailwind Antora UI matching wincon
The Antora default UI had no design relationship to wintermeyer-consulting.de (Roboto webfonts, generic blue/grey palette, no dark mode). A reader clicking through from wincon to this book landed in a site that looked unrelated. Replace the default UI with a custom bundle in ui-bundle/ built on Tailwind v4, authored to the same tokens as wincon: system fonts only (system-ui / Georgia / ui-monospace), neutral-50/#0e0e0e backgrounds, neutral-900/#f0ede6 text, lime-700/#c8f55a accent. Dark mode via prefers-color-scheme with no toggle. Chrome mirrors wincon's top_nav and four-column footer. Structural changes beyond the CSS: - New ui-bundle/ keeps Antora's handlebars plumbing (helpers, layouts, nav-menu, site.js) so sidebar toggle, copy-code button, and link resolution keep working. Only header-content.hbs and footer-content.hbs are rewritten for wincon chrome. - antora.yml `version: ~` so URLs drop the /main/ segment; the book now lives at /book/index.html, /book/phoenix/index.html, etc. - Playbooks now point at the local bundle zip; supplemental-ui/ is removed (superseded by the bundle). - .tool-versions bumped to nodejs 20.19.0 for Tailwind v4. Content-area restyle under .doc covers all AsciiDoc output: admonitions (NOTE/TIP/WARNING/CAUTION/IMPORTANT) with attr(title) labels, code blocks on #131313, tables, callout pills with the <b>(N)</b> text fallback suppressed, inline-code overflow-wrap to prevent mobile overflow. The sticky breadcrumb band tried earlier is gone in favour of a small serif-italic "← <book title>" kicker above each h1 — harmonises with wincon's Georgia wordmark instead of clashing with a mono uppercase row. Edit-this-page moved to a muted footer row at the end of each article. CI and deploy path are intentionally unchanged in this commit; the sub-path integration into wincon comes in a follow-up.
1 parent c3a9ca6 commit c4b02f2

68 files changed

Lines changed: 3192 additions & 174 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.tool-versions

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
elixir 1.18.3
22
erlang 27.2.3
3-
nodejs 18.16.0
3+
nodejs 20.19.0

README.md

Lines changed: 51 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,54 @@
1-
# Phoenix Beginner's Guide
1+
# Elixir, Phoenix and Ash Beginner's Guide
22

3-
We use https://antora.org to convert the AsciiDoc to HTML.
3+
Content is authored in AsciiDoc under `modules/ROOT/pages/` and rendered
4+
by [Antora](https://antora.org). The visual style matches
5+
[wintermeyer-consulting.de](https://wintermeyer-consulting.de) and is
6+
produced by a custom Tailwind CSS v4 UI bundle that lives in
7+
`ui-bundle/`.
48

5-
Build the HTML with this command:
9+
## Build
610

7-
npx antora antora-playbook.yml
11+
The site build is two steps: first build the UI bundle, then run Antora.
12+
13+
```sh
14+
# 1. Build the UI bundle (produces ui-bundle/build/ui-bundle.zip)
15+
cd ui-bundle
16+
npm install
17+
npm run build
18+
cd ..
19+
20+
# 2. Render the site against the local source (build/site/)
21+
npx antora --fetch antora-local-playbook.yml
22+
```
23+
24+
Open `build/site/index.html` in a browser to preview.
25+
26+
To render the production playbook (pulls content from the remote repo
27+
instead of the working directory), swap step 2 for:
28+
29+
```sh
30+
npx antora --fetch antora-playbook.yml
31+
```
32+
33+
## UI bundle development
34+
35+
Work on the chrome and styles lives in `ui-bundle/src/`:
36+
37+
- `css/site.css` — Tailwind v4 source (`@theme` tokens, `@custom-variant
38+
dark`, and `@apply`-scoped rules for Antora's class surface)
39+
- `partials/header-content.hbs`, `partials/footer-content.hbs` — the
40+
wincon-matching top nav and four-column footer
41+
- `partials/*.hbs`, `layouts/*.hbs`, `helpers/*.js`, `js/site.js`,
42+
`img/*.svg` — carried from the Antora default UI so Antora's internal
43+
plumbing and sidebar JS keep working
44+
45+
For a tight iteration loop:
46+
47+
```sh
48+
cd ui-bundle
49+
npm run dev # Tailwind CLI in watch mode
50+
# then, in another shell, rebuild the bundle + site on demand
51+
npm run build && cd .. && npx antora --fetch antora-local-playbook.yml
52+
```
53+
54+
Dark mode follows the OS `prefers-color-scheme`; there is no toggle.

antora-local-playbook.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,8 @@ content:
1212

1313
ui:
1414
bundle:
15-
url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/master/raw/build/ui-bundle.zip?job=bundle-stable
15+
url: ./ui-bundle/build/ui-bundle.zip
1616
snapshot: true
1717
output_dir: antora-assets
18-
supplemental_files: ./supplemental-ui
1918
runtime:
2019
fetch: true

antora-playbook.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,8 @@ content:
1111

1212
ui:
1313
bundle:
14-
url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/master/raw/build/ui-bundle.zip?job=bundle-stable
14+
url: ./ui-bundle/build/ui-bundle.zip
1515
snapshot: true
1616
output_dir: antora-assets
17-
supplemental_files: ./supplemental-ui
1817
runtime:
1918
fetch: true

antora.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: book
22
title: An Elixir, Phoenix and Ash Beginner's Guide
3-
version: main
3+
version: ~
44
start_page: ROOT:index.adoc
55
nav:
66
- modules/ROOT/nav.adoc

supplemental-ui/css/site-extra.css

Lines changed: 0 additions & 60 deletions
This file was deleted.

supplemental-ui/css/vendor/docsearch.min.css

Lines changed: 0 additions & 2 deletions
This file was deleted.

supplemental-ui/js/vendor/docsearch.min.js

Lines changed: 0 additions & 2 deletions
This file was deleted.

supplemental-ui/partials/footer-content.hbs

Lines changed: 0 additions & 23 deletions
This file was deleted.

supplemental-ui/partials/head-meta.hbs

Lines changed: 0 additions & 5 deletions
This file was deleted.

0 commit comments

Comments
 (0)