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