Skip to content

Add docs which replace the existing preview (currently like-for-like), and include a mathjax demo page similar to the existing preview.html#106

Merged
pelson merged 1 commit into
ipython:masterfrom
pelson:feature/gh-docs
Jul 9, 2026
Merged

Conversation

@pelson

@pelson pelson commented Jul 9, 2026

Copy link
Copy Markdown
Member

No description provided.

…se assets

- docs/ contains the source for github.io: /xkcd-script/ (font preview,
  ported from the old root preview.html) and /mathjax/ (MathJax
  integration demo). Shared site.css + site.js provide the common header
  and querystring-backed share URL.
- docs/build.sh assembles build/html/ by copying docs/ and pulling the
  current release's xkcd-script.{otf,ttf,woff,woff2} + xkcd-mathjax3.js
  into build/html/assets/. Used both locally and by the workflow.
- .github/workflows/pages.yml runs the same script and deploys via
  actions/deploy-pages, triggered on push to master (docs/**), on
  release published, or manually.
- Release artifacts now use unversioned filenames (version stays in the
  font name table and JS header). Enables /releases/latest/download/...
  stable URLs and simplifies docs asset naming.
- Root preview.html removed; docs/preview.html redirects to
  /xkcd-script/ preserving querystring + hash.
@pelson

pelson commented Jul 9, 2026

Copy link
Copy Markdown
Member Author

Nothing really controversial here - it is infrastructure to help us build out more docs functionality (including a clear how-to on using the mathjax integration). Merging.

@pelson pelson merged commit e7db40b into ipython:master Jul 9, 2026
3 checks passed
@pelson pelson deleted the feature/gh-docs branch July 9, 2026 03:27
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