File: README.md

package info (click to toggle)
jupyter-server-mathjax 0.2.6-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 140 kB
  • sloc: python: 126; javascript: 73; makefile: 12
file content (51 lines) | stat: -rw-r--r-- 998 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
45
46
47
48
49
50
51
# MathJax resources endpoints for Jupyter Server

![Testing](https://github.com/jupyter-server/jupyter_server_mathjax/workflows/Testing/badge.svg)



## Basic Usage

Install from PyPI:

```sh
> pip install jupyter_server_mathjax
```

This will automatically enable the extension in Jupyter Server.

To test the installation, you can run Jupyter Server and visit the `/static/jupyter_server_mathjax/MathJax.js` endpoint:

```sh
> jupyter server
```

## Maintenance Notes

To install an editable install locally for development, first clone the repository locally,
then run:

```sh
`pip install -e .[test]`
```

Note that the editable install will not install the data file that
automatically configures the extension for use. To manually enable it, run:

```sh
jupyter server extension enable --py jupyter_server_mathjax
```

To build for distribution, use the `build` package:

```sh
pip install build
python -m build
```

Then release using twine:

```sh
twine check dist/*
twine check dist/*
```