commit - f76d96eca0fca63ef663748521e498030897f9ad
commit + 76524214d5cfa412ee9ae29698f2114a5d57f742
blob - 46e9c46a944472df4626064c49504fb639eac417 (mode 644)
blob + /dev/null
--- .github/FUNDING.yml
+++ /dev/null
-github: maaslalani
blob - dd84ea7824f11be1eeda22377549cbc1aec7f980 (mode 644)
blob + /dev/null
--- .github/ISSUE_TEMPLATE/bug_report.md
+++ /dev/null
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
-
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
-
-**Additional context**
-Add any other context about the problem here.
blob - bbcbbe7d61558adde3cbfd0c7a63a67c27ed6d30 (mode 644)
blob + /dev/null
--- .github/ISSUE_TEMPLATE/feature_request.md
+++ /dev/null
----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.
blob - 5fd686ed62e77bf0fd30a73b7ff7e4b370d58cc8 (mode 644)
blob + /dev/null
--- .github/pull_request_template.md
+++ /dev/null
-Fixes #...
-
-### Changes Introduced
--
--
--
blob - 948f151ddb24d7135350bc8960f26faad019d3b4 (mode 644)
blob + /dev/null
--- CODE_OF_CONDUCT.md
+++ /dev/null
-# Code of Conduct
-
-Be nice please!
blob - 44401e598b575655d7d545c0f3c87624b5c316f9 (mode 644)
blob + /dev/null
--- CONTRIBUTING.md
+++ /dev/null
-Take a look at the [Development Docs](./docs/development/README.md).
-
-Pull requests are welcome!
blob - 99f45067ce5382772108b27e7309be0151953d8d
blob + 21adeee2fa0c6b56940ddf2c40262120a72d3f86
--- LICENSE
+++ LICENSE
MIT License
Copyright (c) 2021 Maas Lalani
+Copyright (c) 2026 Richard7987
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
blob - b1e25433565fb646c22c3e7fb32611f9bd550f07
blob + b32bfb6b0082fdfce492478c1909ce8084e3554d
--- README.md
+++ README.md
# Slides
-Slides in your terminal.
+Slides in your terminal — personal fork of [maaslalani/slides](https://github.com/maaslalani/slides)
+with real LaTeX rendering, real images with captions, and numbered
+bibliography/citations, built for academic and scientific presentations.
<p align="center">
<img src="./assets/slides-1.gif?raw=true" alt="Slides Presentation" />
</p>
+### What's different from upstream
+
+* **LaTeX math** — `$...$` inline math renders as Unicode text inline with
+ the surrounding prose; `$$...$$` block math renders as a real image via
+ [tectonic](https://tectonic-typesetting.github.io/) + Ghostscript.
+* **Real images** — `` shows the actual image (not
+ just alt text) via the Kitty Graphics Protocol, with the caption
+ rendered below it. Falls back to plain alt text on terminals without
+ Kitty graphics support.
+* **Bibliography & citations** — `[@key]` citations are numbered by order
+ of first appearance and resolved against a `.bib` file, with a
+ References slide generated automatically at the end. See
+ `bibliography` under [Configuration](#configuration).
+* Layout/margin/sizing tuned for presenting on a projector (see
+ `examples/` for a real worked example — not checked in, but built the
+ same way you would build your own).
+
+Everything else — navigation, search, code execution, SSH — works exactly
+like upstream `slides`, documented below.
+
### Installation
-[](https://formulae.brew.sh/formula/slides)
-[](https://snapcraft.io/slides)
-[](https://aur.archlinux.org/packages/slides)
-<details markdown="block">
-<summary>Instructions</summary>
+This fork isn't published to any package manager. Build it from source:
-#### MacOS
```
-brew install slides
-```
-#### Arch
-```
-yay -S slides
-```
-#### Nixpkgs (unstable)
-```
-nix-env -iA nixpkgs.slides
-```
-#### Any Linux Distro running `snapd`
-```
-sudo snap install slides
-```
-#### Go
-```
-go install github.com/maaslalani/slides@latest
-```
-From source:
-```
-git clone https://github.com/maaslalani/slides.git
+git clone <this repo>
cd slides
go install
```
-You can also download a binary from the [releases](https://github.com/maaslalani/slides/releases) page.
+Or, with the Nix flake in this repo (also brings in `tectonic` and
+`ghostscript`, needed for LaTeX rendering):
-</details>
+```
+nix build # ./result/bin/slides
+# or, for a dev shell with go/gopls/tectonic/ghostscript on PATH:
+nix develop
+```
-
### Usage
Create a simple markdown file that contains your slides:
````
-Checkout the [example slides](https://github.com/maaslalani/slides/tree/main/examples).
+Checkout the [example slides](./examples).
Then, to present, run:
```
chmod +x file.md
```
+### LaTeX math
+
+Write ordinary LaTeX math in your markdown:
+
+```
+Inline: $\alpha^2 + \beta \leq \gamma$, rendered as Unicode text.
+
+Block:
+$$\int_0^\infty e^{-x^2}\,dx = \frac{\sqrt{\pi}}{2}$$
+```
+
+Inline math (`$...$`) is approximated as Unicode text so it flows with
+the surrounding paragraph. Block math (`$$...$$`) is compiled with
+tectonic and rasterized with Ghostscript into a real image, shown the
+same way as a regular image. If graphics aren't supported by your
+terminal, block math falls back to the same Unicode approximation as
+inline math.
+
+### Images
+
+```
+
+```
+
+Shown as a real image via the Kitty Graphics Protocol (with the caption
+rendered below it) on terminals that support it; falls back to plain alt
+text everywhere else.
+
+### Bibliography & citations
+
+Point `bibliography` (see [Configuration](#configuration)) at a `.bib`
+file, then cite entries anywhere in your slides:
+
+```
+This result matches prior work [@smith2020].
+```
+
+Citations are numbered by order of first appearance across the whole
+presentation; the same key cited again reuses its number. A `References`
+slide listing every cited entry (IEEE-ish numeric style) is appended
+automatically. Keys not found in the `.bib` file are left as literal
+`[@key]` text.
+
### Configuration
`slides` allows you to customize your presentation's look and feel with metadata at the top of your `slides.md`.
author: Gopher
date: MMMM dd, YYYY
paging: Slide %d / %d
+bibliography: ./path/to/refs.bib
---
```
will be replaced with the current slide number and the second `%d` will be
replaced with the total slides count. Defaults to `Slide %d / %d`.
You will need to surround the paging value with quotes if it starts with `%`.
+* `bibliography`: Path to a `.bib` file, relative to the slides file. Enables
+ `[@key]` citations and an auto-generated References slide. Omit to leave
+ the feature off entirely.
#### Date format
but does have `ssh`. Or, let your viewers have access to the slides on their
own computer without needing to download `slides` and the presentation file.
-### Alternatives
+### Credits
-**Credits**: This project was heavily inspired by [`lookatme`](https://github.com/d0c-s4vage/lookatme).
+This is a personal fork of [maaslalani/slides](https://github.com/maaslalani/slides),
+which was itself heavily inspired by [`lookatme`](https://github.com/d0c-s4vage/lookatme).
-* [`lookatme`](https://github.com/d0c-s4vage/lookatme)
-* [`sli.dev`](https://sli.dev/)
-* [`sent`](https://tools.suckless.org/sent/)
-* [`presenterm`](https://github.com/mfontanini/presenterm)
-
### Development
See the [development documentation](./docs/development)
blob - 67c8a9c166f3794e324ec453054b7d3b28dade90 (mode 644)
blob + /dev/null
--- SECURITY.md
+++ /dev/null
-# Security Policy
-
-## Reporting a Vulnerability
-
-Email [maas@lalani.dev](mailto:maas@lalani.dev)
