MDBook Presentation Preprocessor
A preprocessor for utilizing an MDBook as slides for a presentation.
The goal of this project is to allow the writing of one MDBook that can be used as both presentation and mdbook style website.
See it in action here, the source for this is in the example directory.
Usage
First you need to install the pre-processor by running the following command.
Next you need to add the preprocessor to your book.toml
[]
= ["Your Name"]
= false
= "src"
= "An Interesting Thing"
[]
[]
Now you can freely use the following syntax to mark sections of your book as web only or presentation only.
$web-only$
This content should only be displayed when the page
is in web presentation mode
$web-only-end$
$slides-only$
This content should only be displated when the page
is in slide presentation mode
$slides-only-end$
To toggle between slides and web, you can press alt+p
.
A current limitation is that you would not be able to conditional extend a bulleted or numbered list. Instead it will create a second list just below the first.
Since MDBook doesn't offer paging from the /
route, if you
are in presentation mode and at /
, it will automatically
reload the page at the first entry in the navigation list.
How It Works
The preprocessor will extract the text from the
tags and passes it to pulldown-cmark
to convert
it into HTML. The output is wrapped in the following
<!-- For $slides-only$ tagged items -->
<!-- Content would go here-->
<!-- For $web-only$ tagged items -->
<!-- Content would go here-->
Since inline HTML is still valid markdown it shouldn't impact the rest of your book's ability to render.
It also inserts some css
as js
to each page.
The js
does a few things, maintains a new localStorage
variable
presentation_mode
. The value 1
is for web and the value 0
is for presentation. It also listens for the alt+p
shortcut.
Depending on the value of presentation_mode
it will update
all of the wrapped items to have an additional class of
either presenting
or not-presenting
. The css
will set display: hidden;
for any items that are
.article-content.presenting
or .presentation-only.not-presenting
.
Contributing
If you are interested in contributing, I would be happy for the help
If you are find a bug, please open an issue!
If you want to make a change to the source code, please consider the following
- The
./presentationHider.ts
file is where you should be editing any of the javascript- To update the actual javascript, please run
tsc --outFile ./src/presentationHider.js
- To update the actual javascript, please run
- The
./presentationHider.scss
file is where you should be editing any of the css- To update the actual css please run your sass compiler of choice to update
./src/presentationHider.css
- I personally use
rsass
with the following commandrsass ./presentationHider.scss > ./src/presentationHider.css
- To update the actual css please run your sass compiler of choice to update
- When editing any of the rust functionality, please keep any of the logic outside of the
impl Preprocessor
block to allow the code to be tested
For reference see the api docs