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

Updating installation docs page. Added the Git install method and changed the archive method to the GitHub downloads.

Browse Source
This commit is contained in:
Casey W. Stark 2010-11-02 20:32:35 -07:00
parent b7a286cb2c
commit 6cec11ee94
7 changed files with 167 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
mathjax/docs/html/.doctrees/environment.pickle
View File

Binary file not shown.

BIN
mathjax/docs/html/.doctrees/installation.doctree
View File

Binary file not shown.

72
mathjax/docs/html/_sources/installation.txt
View File

@ -4,12 +4,61 @@
Installing and Testing MathJax Installing and Testing MathJax
****************************** ******************************
MathJax can be loaded from a public web server or privately from your MathJax can be loaded from a public web server or privately from your hard drive
hard drive or other local media. To use MathJax in either way, you or other local media. To use MathJax in either way, you will need to obtain a
will need to obtain a copy of MathJax and its font package. There are copy of MathJax and its font package. There are three ways to do this: via
two main ways to do this: via ``svn`` or via a pre-packaged archive. ``git``, ``svn``, or via a pre-packaged archive. We recommend git or svn, as it
We recommend the former, as it is easier to keep your installation up is easier to keep your installation up to date.
to date using ``svn``.
.. _getting-mathjax-git:
Obtaining MathJax via Git
=========================
The easiest way to get MathJax and keep it up to date is to use the `Git
<http://git-scm.com/>`_ version control system to access our `GitHub repository
<http://github.com/mathjax/mathjax>`_. Use the commands
.. code-block:: sh
git clone git://github.com/mathjax/MathJax.git mathjax
cd mathjax
unzip fonts.zip
to obtain and set up a copy of MathJax.
Whenever you want to update MathJax, you can now use
.. code-block:: sh
cd mathjax
git status
to check if there are updates to MathJax. If MathJax needs updating, use
.. code-block:: sh
cd mathjax
git pull origin
# if fonts.zip is updated, do the following as well:
rm -rf fonts
unzip fonts.zip
to udpate your copy of MathJax to the current release version. If the
``fonts.zip`` file has been updated, you will need to remove the old fonts
directory and unpack the new one bring your installation up to date. If you keep
MathJax updated in this way, you will be sure that you have the latest bug fixes
and new features as they become available.
This gets you the current development copy of MathJax, which is the
"bleeding-edge" version that contains all the latest changes to MathJax. At
times, however, these may be less stable than the "release" version. If you
prefer to use the most stable version (that may not include all the latest
patches and features), use ``git tag -l`` to see all versions and use ``git
checkout <tag_name>`` to checkout that version of MathJax. When you want to
upgrade to a new release, you will need to repeat this for the latest release
tag.
.. _getting-mathjax-svn: .. _getting-mathjax-svn:
@ -17,9 +66,9 @@ to date using ``svn``.
Obtaining MathJax via SVN Obtaining MathJax via SVN
========================= =========================
The easiest way to get MathJax and keep it up to date is to use the If you are more comfortable with the `subversion
`subversion <http://subversion.apache.org/>`_ source control system, <http://subversion.apache.org/>`_ source control system, you may want to use
``svn``. Use the commands our svn mirror. If you want to get the latest svn revision, use the commands
.. code-block:: sh .. code-block:: sh
@ -80,9 +129,8 @@ 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
`SourceForge files page `GitHub downloads <http://github.com/mathjax/mathjax/>`_ (click the big download
<http://sourceforge.net/projects/mathjax/files/>`_, where you can button on the right), where you can download the archives that you need.
download the archives that you need.
You should download the ``MathJax-v1.0.1.zip`` file, then simply unzip You should download the ``MathJax-v1.0.1.zip`` file, 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

57
mathjax/docs/html/installation.html
View File

@ -49,17 +49,51 @@
<div class="section" id="installing-and-testing-mathjax"> <div class="section" id="installing-and-testing-mathjax">
<span id="installation"></span><h1>Installing and Testing MathJax<a class="headerlink" href="#installing-and-testing-mathjax" title="Permalink to this headline"></a></h1> <span id="installation"></span><h1>Installing and Testing MathJax<a class="headerlink" href="#installing-and-testing-mathjax" title="Permalink to this headline"></a></h1>
<p>MathJax can be loaded from a public web server or privately from your <p>MathJax can be loaded from a public web server or privately from your hard drive
hard drive or other local media. To use MathJax in either way, you or other local media. To use MathJax in either way, you will need to obtain a
will need to obtain a copy of MathJax and its font package. There are copy of MathJax and its font package. There are three ways to do this: via
two main ways to do this: via <tt class="docutils literal"><span class="pre">svn</span></tt> or via a pre-packaged archive. <tt class="docutils literal"><span class="pre">git</span></tt>, <tt class="docutils literal"><span class="pre">svn</span></tt>, or via a pre-packaged archive. We recommend git or svn, as it
We recommend the former, as it is easier to keep your installation up is easier to keep your installation up to date.</p>
to date using <tt class="docutils literal"><span class="pre">svn</span></tt>.</p> <div class="section" id="obtaining-mathjax-via-git">
<span id="getting-mathjax-git"></span><h2>Obtaining MathJax via Git<a class="headerlink" href="#obtaining-mathjax-via-git" title="Permalink to this headline"></a></h2>
<p>The easiest way to get MathJax and keep it up to date is to use the <a class="reference external" href="http://git-scm.com/">Git</a> version control system to access our <a class="reference external" href="http://github.com/mathjax/mathjax">GitHub repository</a>. Use the commands</p>
<div class="highlight-sh"><div class="highlight"><pre>git clone git://github.com/mathjax/MathJax.git mathjax
<span class="nb">cd </span>mathjax
unzip fonts.zip
</pre></div>
</div>
<p>to obtain and set up a copy of MathJax.</p>
<p>Whenever you want to update MathJax, you can now use</p>
<div class="highlight-sh"><div class="highlight"><pre><span class="nb">cd </span>mathjax
git status
</pre></div>
</div>
<p>to check if there are updates to MathJax. If MathJax needs updating, use</p>
<div class="highlight-sh"><div class="highlight"><pre><span class="nb">cd </span>mathjax
git pull origin
<span class="c"># if fonts.zip is updated, do the following as well:</span>
rm -rf fonts
unzip fonts.zip
</pre></div>
</div>
<p>to udpate your copy of MathJax to the current release version. If the
<tt class="docutils literal"><span class="pre">fonts.zip</span></tt> file has been updated, you will need to remove the old fonts
directory and unpack the new one bring your installation up to date. If you keep
MathJax updated in this way, you will be sure that you have the latest bug fixes
and new features as they become available.</p>
<p>This gets you the current development copy of MathJax, which is the
&#8220;bleeding-edge&#8221; version that contains all the latest changes to MathJax. At
times, however, these may be less stable than the &#8220;release&#8221; version. If you
prefer to use the most stable version (that may not include all the latest
patches and features), use <tt class="docutils literal"><span class="pre">git</span> <span class="pre">tag</span> <span class="pre">-l</span></tt> to see all versions and use <tt class="docutils literal"><span class="pre">git</span>
<span class="pre">checkout</span> <span class="pre">&lt;tag_name&gt;</span></tt> to checkout that version of MathJax. When you want to
upgrade to a new release, you will need to repeat this for the latest release
tag.</p>
</div>
<div class="section" id="obtaining-mathjax-via-svn"> <div class="section" id="obtaining-mathjax-via-svn">
<span id="getting-mathjax-svn"></span><h2>Obtaining MathJax via SVN<a class="headerlink" href="#obtaining-mathjax-via-svn" title="Permalink to this headline"></a></h2> <span id="getting-mathjax-svn"></span><h2>Obtaining MathJax via SVN<a class="headerlink" href="#obtaining-mathjax-via-svn" title="Permalink to this headline"></a></h2>
<p>The easiest way to get MathJax and keep it up to date is to use the <p>If you are more comfortable with the <a class="reference external" href="http://subversion.apache.org/">subversion</a> source control system, you may want to use
<a class="reference external" href="http://subversion.apache.org/">subversion</a> source control system, our svn mirror. If you want to get the latest svn revision, use the commands</p>
<tt class="docutils literal"><span class="pre">svn</span></tt>. Use the commands</p>
<div class="highlight-sh"><div class="highlight"><pre>svn co http://mathjax.svn.sourceforge.net/svnroot/mathjax/trunk/mathjax mathjax <div class="highlight-sh"><div class="highlight"><pre>svn co http://mathjax.svn.sourceforge.net/svnroot/mathjax/trunk/mathjax mathjax
<span class="nb">cd </span>mathjax <span class="nb">cd </span>mathjax
unzip fonts.zip unzip fonts.zip
@ -106,8 +140,8 @@ release number.</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://sourceforge.net/projects/mathjax/files/">SourceForge files page</a>, where you can <a class="reference external" href="http://github.com/mathjax/mathjax/">GitHub downloads</a> (click the big download
download the archives that you need.</p> button on the right), where you can download the archives that you need.</p>
<p>You should download the <tt class="docutils literal"><span class="pre">MathJax-v1.0.1.zip</span></tt> file, then simply unzip <p>You should download the <tt class="docutils literal"><span class="pre">MathJax-v1.0.1.zip</span></tt> file, 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
@ -203,6 +237,7 @@ for more details.</p>
<h3><a href="index.html">Table Of Contents</a></h3> <h3><a href="index.html">Table Of Contents</a></h3>
<ul> <ul>
<li><a class="reference internal" href="#">Installing and Testing MathJax</a><ul> <li><a class="reference internal" href="#">Installing and Testing MathJax</a><ul>
<li><a class="reference internal" href="#obtaining-mathjax-via-git">Obtaining MathJax via Git</a></li>
<li><a class="reference internal" href="#obtaining-mathjax-via-svn">Obtaining MathJax via SVN</a></li> <li><a class="reference internal" href="#obtaining-mathjax-via-svn">Obtaining MathJax via SVN</a></li>
<li><a class="reference internal" href="#obtaining-mathjax-via-an-archive">Obtaining MathJax via an archive</a></li> <li><a class="reference internal" href="#obtaining-mathjax-via-an-archive">Obtaining MathJax via an archive</a></li>
<li><a class="reference internal" href="#testing-your-installation">Testing your installation</a></li> <li><a class="reference internal" href="#testing-your-installation">Testing your installation</a></li>

BIN
mathjax/docs/html/objects.inv
View File

Binary file not shown.

2
mathjax/docs/html/searchindex.js
View File

File diff suppressed because one or more lines are too long

72
mathjax/docs/rst/installation.rst
View File

@ -4,12 +4,61 @@
Installing and Testing MathJax Installing and Testing MathJax
****************************** ******************************
MathJax can be loaded from a public web server or privately from your MathJax can be loaded from a public web server or privately from your hard drive
hard drive or other local media. To use MathJax in either way, you or other local media. To use MathJax in either way, you will need to obtain a
will need to obtain a copy of MathJax and its font package. There are copy of MathJax and its font package. There are three ways to do this: via
two main ways to do this: via ``svn`` or via a pre-packaged archive. ``git``, ``svn``, or via a pre-packaged archive. We recommend git or svn, as it
We recommend the former, as it is easier to keep your installation up is easier to keep your installation up to date.
to date using ``svn``.
.. _getting-mathjax-git:
Obtaining MathJax via Git
=========================
The easiest way to get MathJax and keep it up to date is to use the `Git
<http://git-scm.com/>`_ version control system to access our `GitHub repository
<http://github.com/mathjax/mathjax>`_. Use the commands
.. code-block:: sh
git clone git://github.com/mathjax/MathJax.git mathjax
cd mathjax
unzip fonts.zip
to obtain and set up a copy of MathJax.
Whenever you want to update MathJax, you can now use
.. code-block:: sh
cd mathjax
git status
to check if there are updates to MathJax. If MathJax needs updating, use
.. code-block:: sh
cd mathjax
git pull origin
# if fonts.zip is updated, do the following as well:
rm -rf fonts
unzip fonts.zip
to udpate your copy of MathJax to the current release version. If the
``fonts.zip`` file has been updated, you will need to remove the old fonts
directory and unpack the new one bring your installation up to date. If you keep
MathJax updated in this way, you will be sure that you have the latest bug fixes
and new features as they become available.
This gets you the current development copy of MathJax, which is the
"bleeding-edge" version that contains all the latest changes to MathJax. At
times, however, these may be less stable than the "release" version. If you
prefer to use the most stable version (that may not include all the latest
patches and features), use ``git tag -l`` to see all versions and use ``git
checkout <tag_name>`` to checkout that version of MathJax. When you want to
upgrade to a new release, you will need to repeat this for the latest release
tag.
.. _getting-mathjax-svn: .. _getting-mathjax-svn:
@ -17,9 +66,9 @@ to date using ``svn``.
Obtaining MathJax via SVN Obtaining MathJax via SVN
========================= =========================
The easiest way to get MathJax and keep it up to date is to use the If you are more comfortable with the `subversion
`subversion <http://subversion.apache.org/>`_ source control system, <http://subversion.apache.org/>`_ source control system, you may want to use
``svn``. Use the commands our svn mirror. If you want to get the latest svn revision, use the commands
.. code-block:: sh .. code-block:: sh
@ -80,9 +129,8 @@ 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
`SourceForge files page `GitHub downloads <http://github.com/mathjax/mathjax/>`_ (click the big download
<http://sourceforge.net/projects/mathjax/files/>`_, where you can button on the right), where you can download the archives that you need.
download the archives that you need.
You should download the ``MathJax-v1.0.1.zip`` file, then simply unzip You should download the ``MathJax-v1.0.1.zip`` file, 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