File: README.md

package info (click to toggle)
plastex 2.1-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 5,740 kB
  • sloc: python: 20,923; xml: 18,043; ansic: 46; makefile: 34; sh: 23
file content (44 lines) | stat: -rw-r--r-- 1,633 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# plastex

Read more at the github page for the plasTeX project:  http://plastex.github.io/plastex/

Installation of this package is done just like any other Python package.
See the INSTALL file for details.

Once you have plasTeX installed, you can use the command-line utility,
called "plastex" just like latex or pdflatex.  For example, if you
have a LaTeX file called mybook.tex, simple run:

```
plastex mybook.tex
```

This will convert mybook.tex into XHTML (the default renderer).  Of course,
there are many options to control the execution of plastex.  Simply type
"plastex" on the command line without options or arguments to see the
full list of command-line options.

It is also possible to write your own command-line utilities that leverage
the power of the plasTeX framework.  In fact, the essence of the "plastex"
command can be written in just one line of code (not including the Python
import commands):

```
import sys
from plasTeX.TeX import TeX
from plasTeX.Renderers.XHTML import Renderer
Renderer().render(TeX(file=sys.argv[1]).parse())
```

plasTeX is really much more than just a LaTeX-to-other-format converter 
though.  See the documentation at http://plastex.github.io/plastex/ for a complete
view of what it is capable of.

## Testing
To run the tests locally, run tox.
This will run tests locally using python 3.5 to 3.7.

## Status
[![Build Status](https://travis-ci.org/plastex/plastex.svg?branch=master)](https://travis-ci.org/plastex/plastex)
[![Coverage Status](https://coveralls.io/repos/github/plastex/plastex/badge.svg?branch=master)](https://coveralls.io/github/plastex/plastex?branch=master)