Dependencies
============

[[Parent]]: remark.txt

In this section we list the dependencies of Remark. 

_This information is not needed to install Remark; `pip` handles the installation of the dependencies as part of the installation of Remark._

Python
------

Remark was programmed in Python 2.7. Thus it should run in any Python 2.x interpreter, where x is at least 7. See [here][PythonInstall] for instructions on installing Python 2.7.

Remark does not currently run under Python 3.

[PythonInstall]: http://docs.python-guide.org/en/latest/starting/installation/

Python dependencies
-------------------

The dependencies to other Python libraries are as follows.
 
### [Python Markdown][PythonMarkdown]

The Python Markdown library is used to convert Markdown to Html. 

It is licensed under the [BSD license][BSD]. 

### [Pygments][Pygments]

The Pygments library is used to highlight source code. 

It is licensed under the [BSD license][BSD].

### [Pillow][Pillow]

The Pillow library is used to create thumbnails for image galleries. 

It is licensed under the [Python Imaging Library license][PIL license].

### [jsonschema][JsonSchema]

The jsonschema library is used to validate JSON config files.

It is licensed under the [MIT license][MIT].


[PythonMarkdown]: https://pythonhosted.org/Markdown/
[Pygments]: http://pygments.org/
[Pillow]: https://python-pillow.github.io/
[BSD]: http://en.wikipedia.org/wiki/BSD_licenses
[PIL license]: http://www.pythonware.com/products/pil/license.htm
[MIT]: http://opensource.org/licenses/MIT
[JsonSchema]: https://github.com/Julian/jsonschema/

Javascript dependencies
-----------------------

The Javascript dependencies are on a per-page basis depending on which features the page uses. The dependencies to Javascript libraries are as follows.

### [Highslide][]

The Highslide library is used to view images in Remark by the [[Link: Gallery_Macro.txt]]. We distribute it with Remark. 

For non-commerical applications, it is licensed under the [Creative Commons Attribution-NonCommerical 3.0 license ][Creative]. It is _not_ free for commercial use. 

* Highslide JS is included in the html code if and only if one invokes the Gallery-macro to generate that page.
* Highslide JS is copied to the output directory if and only if it is included in some html-page.

[Highslide]: http://highslide.com/
[Creative]: http://creativecommons.org/licenses/by-nc/3.0/

### [MathJax][]

The MathJax library is used to interpret and render mathematics in Latex and AsciiMath.

It is licensed under the [Apache license][Apache].

* MathJax is automatically downloaded from the MathJax CDN by the browser.
* MathJax is included in the html code if and only if mathematics is used in the page.

[MathJax]: https://www.mathjax.org/
[Apache]: http://en.wikipedia.org/wiki/Apache_License

