mirror of
https://github.com/Smaug123/KaTeX
synced 2025-10-11 14:08:42 +00:00
38a6ce7990
Summary: Add the dockerfile that I've been using to make huxley screenshots so others can test their changes by making huxley screenshots. Include a readme about how to use it correctly. Test Plan: - Use the dockerfile by running the given commands, see it works Reviewers: alpert Reviewed By: alpert Differential Revision: http://phabricator.khanacademy.org/D12773
29 lines
1.3 KiB
Markdown
29 lines
1.3 KiB
Markdown
### How to generate huxley images
|
|
---------------------------------
|
|
|
|
Now you too can generate huxley images from your own computer, and (hopefully)
|
|
have them look mostly the same as the current ones! To start, make a docker
|
|
image from the included Dockerfile using a command like
|
|
|
|
sudo docker build --tag=huxley .
|
|
|
|
from within this directory (note you need to have docker installed and running
|
|
for this to work). This will build a docker image with the huxley tag,
|
|
which you can then use to run dockers based on them.
|
|
|
|
This huxleyfile is set up such that it will run everything and generate all the
|
|
huxley images when the image is run, so no interactive input is required. All
|
|
that you need to do is mount the KaTeX directory you want to test into the
|
|
`/KaTeX` directory in the docker, and run the huxley docker, like so:
|
|
|
|
sudo docker run --volume=/your/KaTeX/:/KaTeX huxley
|
|
|
|
The `--volume=/your/KaTeX:/KaTeX` switch mounts your KaTeX directory into the
|
|
docker. Note this is a read-write mounting, so the new huxley images will be
|
|
directly placed into your KaTeX directory.
|
|
|
|
Since this docker is very self-contained, there should be no need to do
|
|
interactive management of the docker, but if you feel the need, you can read the
|
|
General Docker Help section of the MathJaxFonts docker readme.
|
|
|
|
That's it! |