Markdowning and updating the README

This commit is contained in:
Casey W. Stark 2011-02-03 18:00:54 -08:00
parent a01f41e0c2
commit 90874621c4

View File

@ -1,54 +1,48 @@
OVERVIEW:
# MathJax
MathJax is an open-source JavaScript display engine for LaTeX and
MathML that works in all modern browsers. It was designed with the
goal of consolidating the recent advances in web technologies into a
single, definitive, math-on-the-web platform supporting the major
browsers and operating systems. It requires no setup on the part of
the user (no plugins to download or software to install), so the page
author can write web documents that include mathematics and be
confident that users will be able to view it naturally and easily.
One simply includes MathJax and some mathematics in a web page, and
MathJax does the rest.
## Beautiful math in all browsers
MathJax is an open-source JavaScript display engine for LaTeX and MathML that
works in all modern browsers. It was designed with the goal of consolidating
the recent advances in web technologies into a single, definitive,
math-on-the-web platform supporting the major browsers and operating systems. It
requires no setup on the part of the user (no plugins to download or software to
install), so the page author can write web documents that include mathematics
and be confident that users will be able to view it naturally and easily. Simply
include MathJax and some mathematics in a web page, and MathJax does the rest.
Some of the main features of MathJax include:
o High-quality display of LaTeX and MathML math notation in HTML pages
o Supported in most browsers with no plug-ins, extra fonts, or special
setup for the reader
o Easy for authors, flexible for publishers, extensible for developers
o Supports math accessibility, cut and paste interoperability and other
advanced functionality
o Powerful API for integration with other web applications
- High-quality display of LaTeX and MathML math notation in HTML pages
- Supported in most browsers with no plug-ins, extra fonts, or special setup for
the reader
- Easy for authors, flexible for publishers, extensible for developers
- Supports math accessibility, cut and paste interoperability and other advanced
functionality
- Powerful API for integration with other web applications
See http://www.mathjax.org/ for additional details.
## Installation and Usage
INSTALLATION AND USAGE:
The MathJax installation and usage documentation is available on the
docs/html directory of the MathJax distribution (see
docs/html/index.html for the starting point). The documents are also
The MathJax installation and usage documentation is available in the
`docs/build/html` directory of the MathJax distribution (see
`docs/build/html/index.html` for the starting point). The documents are also
available on the MathJax web site on line at
http://www.mathjax.org/docs/
> http://www.mathjax.org/docs/
COMMUNITY:
## Community
The main MathJax website is www.mathjax.org, and it includes announcements
and other important information. MathJax also has a SourceForge site at
http://sourceforge.net/projects/mathjax/ that includes the download site
for the MathJax distribution. A user forum for asking questions and getting
assistance is hosted at Google, and the bug tracker is hosted at GitHub:
The main MathJax website is http://www.mathjax.org, and it includes
announcements and other important information. MathJax is maintained and
distributed on GitHub at http://github.com/mathjax/MathJax. A user forum for
asking questions and getting assistance is hosted at Google, and the bug tracker
is hosted at GitHub:
Bug tracker: https://github.com/mathjax/MathJax/issues
MathJax-Users Group: http://groups.google.com/group/mathjax-users
> Bug tracker: https://github.com/mathjax/MathJax/issues
> MathJax-Users Group: http://groups.google.com/group/mathjax-users
Before reporting a bug, please check that it has not already been reported.
Also, please use the bug tracker for reporting bugs rather than the help
forum.
Also, please use the bug tracker for reporting bugs rather than the help forum.