Terminal based presentation tool
slides
now has the ability to have commands run and executed before presenting slides (pre-processing).
To use this feature, you must:
stdin
, for security reasons)chmod +x file.md
, change file permissions to be able to execute code on slides (for security reasons)In your slides.md
, you can write a code block with this structure (use tildes ~
). When you go to present slides (that are executable, chmod +x slides.md
), slides
will parse the code block and run the command to run
and pass in the text inside the code block as stdin
to the command. The entire code block will then be replace by the stdout
of the command you want to run.
~~~command to run
stdin
~~~
This allows you to:
~~~xargs cat
examples/import.md
~~~
graph-easy
~~~graph-easy --as=boxart
[ A ] -> [ B ]
~~~
(If you come up with useful pre-processing commands/examples, please contribute to https://github.com/maaslalani/slides/blob/main/examples/preprocess.md)
slides
added to nixpkgs-unstable
@ v0.3.0javascript
code execution (using node
)elixir
code execution (thanks to @suzaku)~~~
as a slide delimiter (for pre-processing), use ---
always instead.If given a filename: slides file.md
, Slides will automatically watch the file for changes and update your presentation live (thanks to @sibprogrammer)
When there is a code block on the current slide, you can press ctrl+e to execute it and the output will display as virtual text on the slide at the end. Supported languages are:
User customizable themes: Slides allows you to customize your presentation's theme (thanks to @brittonhayes).
In your presentation.md file prepend the following configuration.
---
theme: dark
---
theme can be any one of the following:
dark
light
ascii
notty
./theme.json
You can pass a path to a JSON
file that specifies your theme. Check out the default theme.json
to use as a base for your custom theme.42c7a73 Merge pull request #17 from maaslalani/stdin
3da7238 Documentation: stdin and curling remote slides
58d4b02 Read slides from stdin
f68b802 Use chroma theme: dracula
5d89bf2 Fix #14: go vet ./...
Redefinition
906add1 Merge pull request #12 from sibprogrammer/bugfix-modification-date-format
3126301 Fix #11 Correct date format
22b6fa2 go 1.16 6699e8a Create goreleaser.yml 95634ae Merge pull request #6 from sibprogrammer/bugfix-slide-separator 2489fac Merge pull request #8 from sibprogrammer/bugfix-slide-numbers 4e94e57 Merge pull request #4 from sibprogrammer/bugfix-makefile-errors a108f30 Fix #7 Display the correct number of slides and current one 0a15388 Fix #5 Allow to use triple dashes as a slide separator adb8dba Fix Makefile errors 47d2a87 embed styles 9b249b6 Revert "no need for user to specify theme.json" 7af1081 no need for user to specify theme.json e90002f Merge pull request #3 from angristan/render-error 17a5ed7 Show markdown rendering error to user cb40fa9 pr template 9480b07 Create CONTRIBUTING.md 9be3b16 Update issue templates 59326ce add space as next slides, swap down & up keys 1c6b5df Add credits 0f1ebff remove double import ffca702 moar eceb2c4 lil more error handling 44cfcf6 Remove hardcoded values babdab1 Move demo to top 6ed3fe6 Add readme.md 0c87800 Create makefile 1cf7d3f Create license debbccc theme.json 20c68ad JoinVertical 5bcb013 progress d27e870 WIP 39df02c Markdown 6fc439b Initial commit