Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jonzeolla/monopreso
My monorepo of presentations
https://github.com/jonzeolla/monopreso
Last synced: about 7 hours ago
JSON representation
My monorepo of presentations
- Host: GitHub
- URL: https://github.com/jonzeolla/monopreso
- Owner: JonZeolla
- Created: 2023-11-15T16:18:55.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-28T15:22:52.000Z (21 days ago)
- Last Synced: 2024-10-28T16:38:01.652Z (21 days ago)
- Language: HTML
- Size: 47.2 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Monopreso
This is a monorepo of presentations developed with the wonderful `reveal.js` framework.
Some under-the-hood manipulation is needed in order to use `reveal.js` as a strict submodule (and use certain features like external Markdown[^1]), so
please use the `./start.sh` script to setup and run your presentation.
To print your presentation, start it and browse to http://localhost:8000/?showNotes=separate-page&print-pdf#/
## Getting Started
Ensure you have `docker`, `uv`, and `python3` installed locally, and the docker daemon is running.
Then, you can open a presentation via:
```bash
# Initialize the repo
task -v init
# List the available presentations
./start.sh --list
# Pick a presentation, and run it
./start.sh --preso=iac_security
```
There are also some demos which may require `pipenv`.
If you're actively working on a presentation or module, you can also use `task start` and it will start the presentation of the directory that you're in.
There are some other features you may want to look at, by passing `-h` or `--help`:
```bash
$ ./start.sh -h
Preferred Usage: ./start.sh --preso=PRESENTATION [--list] [--branding=BRANDING] [--no-open] [--no-cleanup]
--branding Use the specified branding i.e. --branding=seiso
--list List the available presentations
--preso The presentation name i.e. --preso=dev_tls
--no-open Don't open the presentation in Chrome automatically
--no-cleanup Disable the cleanup prompt at the end
-h|--help Usage details
```
You can combine these features, like:
```bash
./start.sh --preso=iac_security --no-open --no-cleanup --branding=seiso
```
If you'd like to create a new module or presentation, run `./create.sh -h` and go from there.
## Updates
Update the asciinema javascript and css using the artifacts here[^2].
Also, you can run the following to update the project dependencies.
```bash
task update
```
[^1]: https://revealjs.com/installation/#full-setup
[^2]: https://github.com/asciinema/asciinema-player/releases