diff --git a/README.md b/README.md index eec5164..1e57ee9 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,9 @@ # MakieTeX.jl + +[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliaplots.github.io/MakieTeX.jl/stable/) +[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://juliaplots.github.io/MakieTeX.jl/dev/) +[![Build Status](https://github.com/JuliaPlots/MakieTeX.jl/actions/workflows/CI.yml/badge.svg?branch=master)](https://github.com/JuliaPlots/MakieTeX.jl/actions/workflows/CI.yml?query=branch%3Amaster) + ## LaTeX integration for Makie.jl diff --git a/docs/src/index.md b/docs/src/index.md index 7844a08..0cbb272 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -2,10 +2,19 @@ MakieTeX is a package that allows users to plot vector images - PDF, SVG, and TeX (which compiles to PDF) directly in Makie. It exposes two approaches: the `teximg` recipe which plots any LaTeX-like object, and the `CachedDocument` API which allows users to plot documents directly as `scatter` markers. +To see a list of all exported functions, types, and macros, see the [API](@ref api) page. +```@example LTeX +using MakieTeX, CairoMakie -```@index +teximg(raw""" +\begin{align*} +\frac{1}{2} \times \frac{1}{2} = \frac{1}{4} +\end{align*} +""") ``` + + ## Principle of operation ### Rendering