summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/docshots/README.md
blob: 3e8327ed798ee5c4ec58d1e390adac659352ac57 (plain)
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
[![l3build](https://github.com/yegor256/docshots/actions/workflows/l3build.yml/badge.svg)](https://github.com/yegor256/docshots/actions/workflows/l3build.yml)
[![CTAN](https://img.shields.io/ctan/v/docshots)](https://ctan.org/pkg/docshots)
[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/yegor256/docshots/blob/master/LICENSE.txt)

This LaTeX package helps you show TeX code next to their PDF snapshots,
in two-column formatting. You can use it either in `.dtx` documentation
or in `.tex` file.

First, [install it](https://en.wikibooks.org/wiki/LaTeX/Installing_Extra_Packages)
from [CTAN](https://ctan.org/pkg/docshots)
and then use like this:

```tex
\begin{docshot}
\documentclass{article}
\pagestyle{empty}
\begin{document}
  Hello, \LaTeX!
\end{document}
\end{docshot}
```

If you want to contribute yourself, make a fork, then create a branch, 
then run `l3build ctan` in the root directory.
It should compile everything without errors. If not, submit an issue and wait.
Otherwise, make your changes and then run `l3build ctan` again. If the build is
still clean, submit a pull request.