From 8fd98950aa26a8a817877678356edcc9d42ff131 Mon Sep 17 00:00:00 2001 From: Phil Elson Date: Thu, 9 Jul 2026 05:36:15 +0200 Subject: [PATCH] Add docs/ landing page; update preview.html links - docs/index.html: landing page linking to the two demos and the GitHub repo (font files + install instructions live there, not on the site). - README.md and preview-link.yml: point at /xkcd-script/ instead of preview.html. docs/preview.html still redirects, so existing external links (with querystring) continue to work. --- .github/workflows/preview-link.yml | 2 +- README.md | 2 +- docs/index.html | 42 ++++++++++++++++++++++++++++++ 3 files changed, 44 insertions(+), 2 deletions(-) create mode 100644 docs/index.html diff --git a/.github/workflows/preview-link.yml b/.github/workflows/preview-link.yml index cb05c66..e533aa4 100644 --- a/.github/workflows/preview-link.yml +++ b/.github/workflows/preview-link.yml @@ -19,6 +19,6 @@ jobs: encoded=$(python3 -c "import urllib.parse, sys; print(urllib.parse.quote(sys.argv[1], safe=''))" "$font_url") gh api "repos/${{ github.repository }}/statuses/${sha}" \ -f state=success \ - -f target_url="https://ipython.org/xkcd-font/preview.html?font=${encoded}" \ + -f target_url="https://ipython.org/xkcd-font/xkcd-script/?font=${encoded}" \ -f description="Click to preview the font from this PR" \ -f context="Font preview" diff --git a/README.md b/README.md index 7ad540b..12e84f6 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ It is far less uniform than ``xkcd``, and we think it is therefore more like a t ![Sample of xkcd-script](xkcd-script/samples/ipsum.png) -You can see the font as a [live preview](https://ipython.github.io/xkcd-font/preview.html), or +You can see the font as a [live preview](https://ipython.org/xkcd-font/xkcd-script/), or for more information about the font and how it is constructed see the [xkcd-script/README](xkcd-script/README.md). Pre-built font files are available directly in this repository: diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..21c37db --- /dev/null +++ b/docs/index.html @@ -0,0 +1,42 @@ + + + + +xkcd-font + + + + + + + +
+

Demos:

+ + +

For the font files, installation instructions, and source, see the + ipython/xkcd-font repository on GitHub. + Pre-built font files ship with every + release.

+
+ + +