Skip to content

Add docs/ landing page and update preview.html links #107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelson merged 1 commit into from
Jul 9, 2026
+44 −2
Merged

Add docs/ landing page and update preview.html links #107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/preview-link.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
42 changes: 42 additions & 0 deletions docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>xkcd-font</title>
<link rel="stylesheet" href="site.css">
<style>
.content {
font-family: xkcd-script;
max-width: 720px;
margin: 2em auto;
padding: 0 1.5em;
font-size: 1.2em;
line-height: 1.6;
}
.content ul { padding-left: 1.4em; }
.content li { margin: 0.4em 0; }
.content a { color: #003366; }
</style>
</head>
<body>

<header class="site-header">
<h1>xkcd-font</h1>
<p class="summary">Fonts derived from the handwriting of @randallmunroe</p>
</header>

<div class="content">
<p>Demos:</p>
<ul>
<li><a href="xkcd-script/">xkcd-script live preview</a> — type your own text, share via URL</li>
<li><a href="mathjax/">MathJax integration</a> — LaTeX rendered with xkcd-script</li>
</ul>

<p>For the font files, installation instructions, and source, see the
<a href="https://github.com/ipython/xkcd-font">ipython/xkcd-font</a> repository on GitHub.
Pre-built font files ship with every
<a href="https://github.com/ipython/xkcd-font/releases/latest">release</a>.</p>
</div>

</body>
</html>
Loading