docs: publish the themed HTML manual to copperline.dev/docs on release#176
Merged
Conversation
The MyST HTML site build is restyled to match copperline.dev (palette, fonts, copper hairline) via docs/site.css, wired up with the book-theme style option, and branded with the chrome wordmark linking back to the main site. A new docs-site.yml workflow rebuilds the HTML with BASE_URL=/docs on every v* tag and pushes it to the website repository, so copperline.dev/docs always serves the latest release's manual. Publishing needs a SITE_DEPLOY_KEY secret holding the private half of a write deploy key for LinuxJedi/copperline.github.io.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this does
Adds an HTML docs pipeline alongside the existing PDF one, so the manual is served at https://copperline.dev/docs and always matches the latest release:
docs/site.cssrestyles the MyST book-theme HTML build to match copperline.dev: the site palette (deep blue-black surfaces, copper/blue accents), Chakra Petch headings, IBM Plex body/mono, the copper gradient hairline under the top nav, copper inline code, and keycap styling for the guide's many{kbd}roles. It only affects the HTML site build; the PDF export is untouched. The@font-facerules point at the fonts self-hosted by the website, so they resolve when served from copperline.dev and fall back to system fonts in local previews.docs/myst.ymlwires the stylesheet up via the book-themestyleoption and brands the top nav with the chrome wordmark (assets/brand/copperline-logo.png), linked back to https://copperline.dev/..github/workflows/docs-site.ymlbuilds the HTML withBASE_URL=/docson everyv*tag (plusworkflow_dispatchfor re-publishing without a release) and pushes the result toLinuxJedi/copperline.github.iounder/docsas a single "Publish docs for vX.Y.Z" commit. GitHub Pages then redeploys the site.Verified locally with
myst build --html --ciand a browser pass over the built site in both color schemes (index, getting-started, and the kbd-heavy UI chapter).Setup needed before the workflow can publish
The publish step needs a write deploy key for the website repository:
The website repository side (nav link,
.nojekyll, initial/docscontent for v0.11.0) is being prepared separately in that repo.🤖 Generated with Claude Code
https://claude.ai/code/session_017qMDTkmSQ48RPeS8AGvy6x