Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
samrobbins85 committed Dec 25, 2020
1 parent 8fe7d36 commit 5f8bba9
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 1 deletion.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,22 @@ This is designed with a similar idea to [Tailwind CSS Typography](https://github
To use it, add `latex-style` to a HTML element, in the same way as you would use `prose` with Tailwind CSS Typography.

You can see an example of how this works [here](https://latex-tailwind.vercel.app/)

This provides two options under the `theme` key,

```js
module.exports = {
//...
theme: {
latex: {
footnotes: true,
syntax: true,
},
},
plugins: [require("latex-tailwind")],
};
```

`footnotes` will enable the styling for footnotes, this works based on the `footnotes` class, so will be applied across your site

`syntax` enables syntax highlighting, this is designed for `prism.js`
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "latex-tailwind",
"description": "A Tailwind CSS plugin for automatically styling plain HTML content with defaults to look like a LaTeX document",
"version": "2.0.1",
"version": "2.0.2",
"license": "MIT",
"scripts": {
"dev": "next",
Expand Down

0 comments on commit 5f8bba9

Please sign in to comment.