Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Slide style with patched reveal-md #36

Merged
merged 2 commits into from
May 23, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,10 +127,14 @@ When writing slides, separate each one using `---`.

Optionally, you can separate slides vertically using `----` between slides.

> Note that Windows uses `\r\n` instead of `\n` as its linefeed character.
> For a regex that supports all operating systems, use `\r?\n` instead of `\n`.
> Ex: `"\r?\n---\r?\n"` and `"\r?\n----\r?\n"` as separators.

If several slides fit closely with some core topic being presented, it may be a good idea to stack those slides vertically.
For example, imagine the core topic was "Code Highlight & Transitions":

<img src="./reveal-md/assets/contributing-examples/vertical-slides.png" alt="vertical-slides" width="300"/>
<img src="./assets/img/place-holder/vertical-slides.png" alt="vertical-slides" width="300"/>

### Using speaker notes

Expand All @@ -148,7 +152,7 @@ subsequent lines are just seen in speaker view.

And here's an example of the result:

<img src="./reveal-md/assets/contributing-examples/speaker-notes-view.png" alt="vertical-slides" width="300"/>
<img src="./assets/img/place-holder/speaker-notes-view.png" alt="vertical-slides" width="300"/>

### Transitions

Expand Down
File renamed without changes
File renamed without changes
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
"scripts": {
"start": "reveal-md ./ --watch",
"help": "reveal-md --help",
"build": "rm -rf build && reveal-md ./ --static build --static-dirs=./reveal-md/assets"
"build": "rm -rf build && reveal-md ./ --static build"
},
"dependencies": {
"reveal-md": "^5.3.3"
"reveal-md": "[email protected]:NukeManDan/reveal-md.git#patch-1"
},
"license": "Unlicensed",
"packageManager": "[email protected]"
Expand Down
12 changes: 6 additions & 6 deletions reveal-md.json
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
{
"title": "Polkadot Blockchain Academy",
"theme": "black",
"assetsDir": "./reveal-md/assets",
"css": [],
"theme": "reveal-md/PBA-theme.css",
"assetsDir": ".",
"css": ["reveal-md/custom-classes.css"],
"separator": "\r?\n---\r?\n",
"verticalSeparator": "\r?\n----\r?\n",
"highlightTheme": "shades-of-purple",
"template": "reveal-md/slide-template.html",
"listingTemplate": "reveal-md/listing-template.html",
"template": "./reveal-md/slide-template.html",
"listingTemplate": "./reveal-md/listing-template.html",
"host": "localhost",
"staticDir": "build",
"scripts": [],
"staticDirs": [],
"staticDirs": ["assets"],
"preprocessor": null,
"glob": "**/*Slides.md"
}
Loading