vincentdoerig/latex-css
1
1
Fork 0
mirror of https://github.com/vincentdoerig/latex-css.git synced 2024-11-12 14:35:16 +03:00
Code Issues Projects Releases Wiki Activity

Add fancy badges & instructions on how to install

Browse Source
This commit is contained in:
Vincent Dörig 2020-05-24 08:25:36 +02:00
parent f31bb547f6
commit 0982ecd10a
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -1,15 +1,40 @@
# [LaTeX.CSS](https://latex.now.sh/)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![latex.css on NPM](https://img.shields.io/npm/v/latex.css.svg?color=green&label=latex.css)](https://www.npmjs.com/package/latex.css)
> LaTeX.css is a minimal, almost class-less CSS library which makes any website look like a LaTeX document. It is based on @davidrzs' [latexCSS](https://github.com/davidrzs/latexcss).
## Getting Started
### Using the `<link>` tag
Add the following code in the head of your project.
```css
<link rel="stylesheet" href="https://latex.now.sh/style.css" />
```
or use a CDN like Unpkg:
```css
<link rel="stylesheet" href="https://unpkg.com/latex.css/style.min.css" />
```
### Using NPM/Yarn
NPM:
```bash
npm install latex.css
```
Yarn:
```bash
yarn add latex.css
```
Add any optional classnames to elements with special styles (author subtitle, abstract, lemmas, theorems, etc.). A list of supported class-based elements can be found [here](https://latex.now.sh/#class-based-elements).
## Contributing