https://github.com/yegor256/docshots

LaTeX package that renders TeX samples next to their PDF snapshots
https://github.com/yegor256/docshots

documentation latex latex-package pdf

Last synced: 29 days ago
JSON representation

LaTeX package that renders TeX samples next to their PDF snapshots

• Host: GitHub
• URL: https://github.com/yegor256/docshots
• Owner: yegor256
• License: mit
• Created: 2022-10-09T18:29:28.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-04-28T06:08:01.000Z (9 months ago)
• Last Synced: 2024-05-01T23:12:15.616Z (9 months ago)
• Topics: documentation, latex, latex-package, pdf
• Language: TeX
• Homepage: https://ctan.org/pkg/docshots
• Size: 195 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Nicely Rendered LaTeX Examples for Your `.dtx` File

[![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

\documentclass{article}

\usepackage{docshots}

\begin{document}

Here is how you can use \LaTeX:

\begin{docshot}

\documentclass{article}

\pagestyle{empty}

\begin{document}

  Hello, \LaTeX!

\end{document}

\end{docshot}

For more informaiton, read \TeX{} Book by Donald Knuth.

\end{document}

```

Otherwise, you can download [`docshots.sty`][sty] and add to your project.

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.

[sty]: https://yegor256.github.io/docshots/docshots.sty