https://github.com/onukura/gitbucket-mathjax-plugin
A GitBucket plugin for rendering Markdown file with MathJax.
https://github.com/onukura/gitbucket-mathjax-plugin
gitbucket gitbucket-plugin
Last synced: 3 months ago
JSON representation
A GitBucket plugin for rendering Markdown file with MathJax.
- Host: GitHub
- URL: https://github.com/onukura/gitbucket-mathjax-plugin
- Owner: onukura
- License: apache-2.0
- Created: 2020-06-11T07:15:40.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-09-06T14:46:17.000Z (over 4 years ago)
- Last Synced: 2025-01-07T20:01:08.720Z (5 months ago)
- Topics: gitbucket, gitbucket-plugin
- Language: Scala
- Homepage:
- Size: 822 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gitbucket-mathjax-plugin
[](https://travis-ci.org/onukura/gitbucket-mathjax-plugin)
A GitBucket plugin for rendering Markdown file with MathJax.
## Screenshot
## Install
1. Download *.jar from Releases.
2. Deploy it to `GITBUCKET_HOME/plugins`.
3. Restart GitBucket.
## Build from source
```sbt
sbt clean package
```
The built package is located at
`target/scala-2.13/gitbucket-mathjax-plugin_2.13-{plugin-version}.jar`.
```sbt
sbt assembly
```
This makes the assembly package
`target/scala-2.13/gitbucket-mathjax-plugin-{plugin-version}.jar`
for deployment.
## Note
MathJax and Markdown syntax conflict in some cases. You need to modify your `.md` file a little bit to solve it. It mentioned at [issue](https://github.com/onukura/gitbucket-mathjax-plugin/issues/1). See also [MathJax Doc.](http://docs.mathjax.org/en/latest/input/tex/html.html?highlight=markdown#interactions-with-content-management-systems) for more details.
## Version
Plugin version|GitBucket version
:---|:---
1.0.x |4.32.x -