suzanne.soy/scribble-math
1
0
Fork 0
Code Issues 8 Pull Requests 3 Actions Packages Projects Releases Wiki Activity

Update instructions for obtaining an archive to correspond better with the GitHub file-naming for distribution files.

Browse Source
This commit is contained in:
Davide P. Cervone 2010-12-31 16:59:15 -05:00
parent 8e0833caac
commit 8e8091939d
8 changed files with 77 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/html/_sources/installation.txt
View File

@ -119,10 +119,13 @@ Obtaining MathJax via an archive
Release versions of MathJax are available in archive files from the Release versions of MathJax are available in archive files from the
`MathJax download page <http://www.mathjax.org/download/>`_ or the `MathJax download page <http://www.mathjax.org/download/>`_ or the
`GitHub downloads <http://github.com/mathjax/mathjax/>`_ (click the big download `GitHub downloads <http://github.com/mathjax/mathjax/>`_ (click the
button on the right), where you can download the archives that you need. big download button on the right), where you can download the archive
that you need.
You should download the ``MathJax-v1.1.zip`` file, then simply unzip You should download the v1.1 archive (which will get you a file with a
name like ``mathjax-MathJax-v1.1-X-XXXXXXXX.zip``, where the X's are
some sequence of random-looking letters and numbers), then simply unzip
it. Once the MathJax directory is unpacked, you should move it to the it. Once the MathJax directory is unpacked, you should move it to the
desired location on your server (or your hard disk, if you are using desired location on your server (or your hard disk, if you are using
it locally rather then through a web server). One natural location is it locally rather then through a web server). One natural location is
@ -130,6 +133,12 @@ to put it at the top level of your web server's hierarchy. That would
let you refer to the main MathJax file as ``/MathJax/MathJax.js`` from let you refer to the main MathJax file as ``/MathJax/MathJax.js`` from
within any page on your server. within any page on your server.
From the `MathJax GitHub download link
<http://github.com/mathjax/mathjax/>`_ (the big download button at the
right), you can also select the ``Download .tar.gz`` or ``Download
.zip`` buttons to get a copy of the current "bleeding-edge" version of
MathJax that contains all the latest changes and bug-fixes.
Testing your installation Testing your installation
========================= =========================

27
docs/html/_sources/start.txt
View File

@ -26,20 +26,21 @@ read the details in order to customize the setup for your pages.
Obtaining and Installing MathJax Obtaining and Installing MathJax
================================ ================================
The easiest way to set up MathJax is to obtain the The easiest way to set up MathJax is to obtain the v1.1 archive from
``MathJax-v1.1.zip`` archive from the `MathJax download page the `MathJax download page <http://www.mathjax.org/download/>`_ (you
<http://www.mathjax.org/download/>`_. This includes both the MathJax code should obtain a file names something like
and the MathJax webfonts, so it is the only file you need. (This is ``mathjax-MathJax-v1.0-X-XXXXXXXX.zip``, where the X's are
different from the beta releases, which had the fonts separate from random-looking letters and numbers). This archive includes both the
the rest of the code). MathJax code and the MathJax webfonts, so it is the only file you
need. (This is different from the beta releases, which had the fonts
separate from the rest of the code).
Unpack the ``MathJax-v1.1.zip`` archive and place the Unpack the archive and place the resulting MathJax folder onto your
resulting MathJax folder onto your web server at a convenient web server at a convenient location where you can include it into your
location where you can include it into your web pages. For example, web pages. For example, making ``MathJax`` a top-level directory on
making ``MathJax`` a top-level directory on your server would be your server would be one natural way to do this. That would let you
one natural way to do this. That would let you refer to the main refer to the main MathJax file via the URL ``/MathJax/MathJax.js``
MathJax file via the URL ``/MathJax/MathJax.js`` from within any page from within any page on your server.
on your server.
Note: While this is the easiest way to set up MathJax initially, there Note: While this is the easiest way to set up MathJax initially, there
is a better way to do it if you want to be able to keep your copy of is a better way to do it if you want to be able to keep your copy of

13
docs/html/installation.html
View File

@ -130,15 +130,22 @@ tagged version.</p>
<span id="getting-mathjax-zip"></span><h2>Obtaining MathJax via an archive<a class="headerlink" href="#obtaining-mathjax-via-an-archive" title="Permalink to this headline"></a></h2> <span id="getting-mathjax-zip"></span><h2>Obtaining MathJax via an archive<a class="headerlink" href="#obtaining-mathjax-via-an-archive" title="Permalink to this headline"></a></h2>
<p>Release versions of MathJax are available in archive files from the <p>Release versions of MathJax are available in archive files from the
<a class="reference external" href="http://www.mathjax.org/download/">MathJax download page</a> or the <a class="reference external" href="http://www.mathjax.org/download/">MathJax download page</a> or the
<a class="reference external" href="http://github.com/mathjax/mathjax/">GitHub downloads</a> (click the big download <a class="reference external" href="http://github.com/mathjax/mathjax/">GitHub downloads</a> (click the
button on the right), where you can download the archives that you need.</p> big download button on the right), where you can download the archive
<p>You should download the <tt class="docutils literal"><span class="pre">MathJax-v1.1.zip</span></tt> file, then simply unzip that you need.</p>
<p>You should download the v1.1 archive (which will get you a file with a
name like <tt class="docutils literal"><span class="pre">mathjax-MathJax-v1.1-X-XXXXXXXX.zip</span></tt>, where the X&#8217;s are
some sequence of random-looking letters and numbers), then simply unzip
it. Once the MathJax directory is unpacked, you should move it to the it. Once the MathJax directory is unpacked, you should move it to the
desired location on your server (or your hard disk, if you are using desired location on your server (or your hard disk, if you are using
it locally rather then through a web server). One natural location is it locally rather then through a web server). One natural location is
to put it at the top level of your web server&#8217;s hierarchy. That would to put it at the top level of your web server&#8217;s hierarchy. That would
let you refer to the main MathJax file as <tt class="docutils literal"><span class="pre">/MathJax/MathJax.js</span></tt> from let you refer to the main MathJax file as <tt class="docutils literal"><span class="pre">/MathJax/MathJax.js</span></tt> from
within any page on your server.</p> within any page on your server.</p>
<p>From the <a class="reference external" href="http://github.com/mathjax/mathjax/">MathJax GitHub download link</a> (the big download button at the
right), you can also select the <tt class="docutils literal"><span class="pre">Download</span> <span class="pre">.tar.gz</span></tt> or <tt class="docutils literal"><span class="pre">Download</span>
<span class="pre">.zip</span></tt> buttons to get a copy of the current &#8220;bleeding-edge&#8221; version of
MathJax that contains all the latest changes and bug-fixes.</p>
</div> </div>
<div class="section" id="testing-your-installation"> <div class="section" id="testing-your-installation">
<h2>Testing your installation<a class="headerlink" href="#testing-your-installation" title="Permalink to this headline"></a></h2> <h2>Testing your installation<a class="headerlink" href="#testing-your-installation" title="Permalink to this headline"></a></h2>

BIN
docs/html/objects.inv
View File

Binary file not shown.

2
docs/html/searchindex.js
View File

File diff suppressed because one or more lines are too long

26
docs/html/start.html
View File

@ -65,18 +65,20 @@ to get MathJax up and running on your web site, but you may want to
read the details in order to customize the setup for your pages.</p> read the details in order to customize the setup for your pages.</p>
<div class="section" id="obtaining-and-installing-mathjax"> <div class="section" id="obtaining-and-installing-mathjax">
<h2>Obtaining and Installing MathJax<a class="headerlink" href="#obtaining-and-installing-mathjax" title="Permalink to this headline"></a></h2> <h2>Obtaining and Installing MathJax<a class="headerlink" href="#obtaining-and-installing-mathjax" title="Permalink to this headline"></a></h2>
<p>The easiest way to set up MathJax is to obtain the <p>The easiest way to set up MathJax is to obtain the v1.1 archive from
<tt class="docutils literal"><span class="pre">MathJax-v1.1.zip</span></tt> archive from the <a class="reference external" href="http://www.mathjax.org/download/">MathJax download page</a>. This includes both the MathJax code the <a class="reference external" href="http://www.mathjax.org/download/">MathJax download page</a> (you
and the MathJax webfonts, so it is the only file you need. (This is should obtain a file names something like
different from the beta releases, which had the fonts separate from <tt class="docutils literal"><span class="pre">mathjax-MathJax-v1.0-X-XXXXXXXX.zip</span></tt>, where the X&#8217;s are
the rest of the code).</p> random-looking letters and numbers). This archive includes both the
<p>Unpack the <tt class="docutils literal"><span class="pre">MathJax-v1.1.zip</span></tt> archive and place the MathJax code and the MathJax webfonts, so it is the only file you
resulting MathJax folder onto your web server at a convenient need. (This is different from the beta releases, which had the fonts
location where you can include it into your web pages. For example, separate from the rest of the code).</p>
making <tt class="docutils literal"><span class="pre">MathJax</span></tt> a top-level directory on your server would be <p>Unpack the archive and place the resulting MathJax folder onto your
one natural way to do this. That would let you refer to the main web server at a convenient location where you can include it into your
MathJax file via the URL <tt class="docutils literal"><span class="pre">/MathJax/MathJax.js</span></tt> from within any page web pages. For example, making <tt class="docutils literal"><span class="pre">MathJax</span></tt> a top-level directory on
on your server.</p> your server would be one natural way to do this. That would let you
refer to the main MathJax file via the URL <tt class="docutils literal"><span class="pre">/MathJax/MathJax.js</span></tt>
from within any page on your server.</p>
<p>Note: While this is the easiest way to set up MathJax initially, there <p>Note: While this is the easiest way to set up MathJax initially, there
is a better way to do it if you want to be able to keep your copy of is a better way to do it if you want to be able to keep your copy of
MathJax up-to-date easily. That uses the <a class="reference external" href="http://git-scm.com/">Git</a> MathJax up-to-date easily. That uses the <a class="reference external" href="http://git-scm.com/">Git</a>

15
docs/rst/installation.rst
View File

@ -119,10 +119,13 @@ Obtaining MathJax via an archive
Release versions of MathJax are available in archive files from the Release versions of MathJax are available in archive files from the
`MathJax download page <http://www.mathjax.org/download/>`_ or the `MathJax download page <http://www.mathjax.org/download/>`_ or the
`GitHub downloads <http://github.com/mathjax/mathjax/>`_ (click the big download `GitHub downloads <http://github.com/mathjax/mathjax/>`_ (click the
button on the right), where you can download the archives that you need. big download button on the right), where you can download the archive
that you need.
You should download the ``MathJax-v1.1.zip`` file, then simply unzip You should download the v1.1 archive (which will get you a file with a
name like ``mathjax-MathJax-v1.1-X-XXXXXXXX.zip``, where the X's are
some sequence of random-looking letters and numbers), then simply unzip
it. Once the MathJax directory is unpacked, you should move it to the it. Once the MathJax directory is unpacked, you should move it to the
desired location on your server (or your hard disk, if you are using desired location on your server (or your hard disk, if you are using
it locally rather then through a web server). One natural location is it locally rather then through a web server). One natural location is
@ -130,6 +133,12 @@ to put it at the top level of your web server's hierarchy. That would
let you refer to the main MathJax file as ``/MathJax/MathJax.js`` from let you refer to the main MathJax file as ``/MathJax/MathJax.js`` from
within any page on your server. within any page on your server.
From the `MathJax GitHub download link
<http://github.com/mathjax/mathjax/>`_ (the big download button at the
right), you can also select the ``Download .tar.gz`` or ``Download
.zip`` buttons to get a copy of the current "bleeding-edge" version of
MathJax that contains all the latest changes and bug-fixes.
Testing your installation Testing your installation
========================= =========================

27
docs/rst/start.rst
View File

@ -26,20 +26,21 @@ read the details in order to customize the setup for your pages.
Obtaining and Installing MathJax Obtaining and Installing MathJax
================================ ================================
The easiest way to set up MathJax is to obtain the The easiest way to set up MathJax is to obtain the v1.1 archive from
``MathJax-v1.1.zip`` archive from the `MathJax download page the `MathJax download page <http://www.mathjax.org/download/>`_ (you
<http://www.mathjax.org/download/>`_. This includes both the MathJax code should obtain a file names something like
and the MathJax webfonts, so it is the only file you need. (This is ``mathjax-MathJax-v1.0-X-XXXXXXXX.zip``, where the X's are
different from the beta releases, which had the fonts separate from random-looking letters and numbers). This archive includes both the
the rest of the code). MathJax code and the MathJax webfonts, so it is the only file you
need. (This is different from the beta releases, which had the fonts
separate from the rest of the code).
Unpack the ``MathJax-v1.1.zip`` archive and place the Unpack the archive and place the resulting MathJax folder onto your
resulting MathJax folder onto your web server at a convenient web server at a convenient location where you can include it into your
location where you can include it into your web pages. For example, web pages. For example, making ``MathJax`` a top-level directory on
making ``MathJax`` a top-level directory on your server would be your server would be one natural way to do this. That would let you
one natural way to do this. That would let you refer to the main refer to the main MathJax file via the URL ``/MathJax/MathJax.js``
MathJax file via the URL ``/MathJax/MathJax.js`` from within any page from within any page on your server.
on your server.
Note: While this is the easiest way to set up MathJax initially, there Note: While this is the easiest way to set up MathJax initially, there
is a better way to do it if you want to be able to keep your copy of is a better way to do it if you want to be able to keep your copy of