Skip to content

Commit

Permalink
Update README.ipynb because sky and cube are not the better options t…
Browse files Browse the repository at this point in the history 
…o showcase the slideshow, it seems some more work is needed to make those option look enough OK
  • Loading branch information
@damianavila
damianavila committed Apr 27, 2019
1 parent 8241775 commit 4cd95a6
Showing 1 changed file with 43 additions and 37 deletions.
80 changes: 43 additions & 37 deletions examples/README.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
}
},
"source": [
"## turn your notebooks into slideshows"
"## Turn your notebooks into slideshows"
]
},
{
Expand All @@ -19,7 +19,7 @@
}
},
"source": [
"press `Space` to proceed"
"Press `Space` to proceed."
]
},
{
Expand All @@ -30,7 +30,7 @@
}
},
"source": [
"you can write a regular Jupyter notebook, with the usual mix of markdown and code cells (keep on pressing `Space`)"
"You can write a regular Jupyter notebook, with the usual mix of markdown and code cells (keep on pressing `Space`)."
]
},
{
Expand All @@ -42,7 +42,7 @@
}
},
"source": [
"in code cells you press `Shift-Enter` as usual to evaluate your code (but for now press `Space` again)"
"In code cells you press `Shift-Enter` as usual to evaluate your code (but for now press `Space` again)."
]
},
{
Expand All @@ -68,7 +68,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"but apart from that, `Space` is your friend"
"But apart from that, `Space` is your friend!"
]
},
{
Expand All @@ -79,7 +79,7 @@
}
},
"source": [
"you're in a browser, so remember that you can always use smaller / larger fonts with keyboard shortcuts like `Alt +` and `Alt -` or similar"
"You're in a browser, so remember that you can always use smaller / larger fonts with keyboard shortcuts like `Alt +` and `Alt -` or similar (it could be `Ctrl` instead of `Alt` depending on the platform you are on)."
]
},
{
Expand Down Expand Up @@ -140,16 +140,16 @@
}
},
"source": [
"# the RISE notebook extension"
"# The RISE notebook extension"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"all this is achieved through the RISE notebook extension\n",
"All this is achieved through the RISE notebook extension.\n",
"\n",
"see full documentation at http://rise.readthedocs.io/"
"See full documentation at http://rise.readthedocs.io/."
]
},
{
Expand All @@ -160,21 +160,21 @@
}
},
"source": [
"# thanks to reveal.js"
"# Thanks to reveal.js"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"the [underlying tool is reveal.js](https://revealjs.com/), and it supports a lot of cool features."
"The underlying tool is [reveal.js](https://revealjs.com/), and it supports a lot of cool features."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"for example you can organize your show into\n",
"For example you can organize your show into:\n",
"\n",
"* slides (left to right)\n",
"* subslides (top to bottom)\n",
Expand All @@ -185,7 +185,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"you do not need to worry, just press `Space` to proceed along the main line"
"You do not need to worry, just press `Space` to proceed along the main line."
]
},
{
Expand All @@ -196,14 +196,14 @@
}
},
"source": [
"for example this is a subslide; observe the cursor in the bottom right corner"
"For example this is a subslide; observe the cursor in the bottom right corner."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"if you press `Shift-Space` - here or anywhere else - you will go backwards, so here it would be up"
"If you press `Shift-Space` - here or anywhere else - you will go backwards, so here it would be up."
]
},
{
Expand All @@ -214,14 +214,14 @@
}
},
"source": [
"# notes"
"# Speaker notes"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"if you now press `t` you should see a second window open, with a presenter view, that shows *Notes* cells - that won't show up in the main slides."
"If you now press `t` you should see a second window open, with a presenter view, that shows *Notes* cells - that won't show up in the main slides."
]
},
{
Expand All @@ -232,7 +232,7 @@
}
},
"source": [
"this is an example of a *Notes* cell"
"This is an example of a *Notes* cell."
]
},
{
Expand All @@ -243,7 +243,7 @@
}
},
"source": [
"next, we'll cover how to tag cells as *Slide*, *SubSlide*, *Fragment* or *Notes*"
"Next, we'll cover how to tag cells as *Slide*, *SubSlide*, *Fragment* or *Notes*."
]
},
{
Expand All @@ -254,14 +254,14 @@
}
},
"source": [
"# how to create slideshows"
"# How to create slideshows"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### step 1: enable slideshow cell toolbar"
"### Step 1: enable slideshow cell toolbar"
]
},
{
Expand All @@ -280,7 +280,7 @@
}
},
"source": [
"### step 2: add appropriate tag to each cell"
"### Step 2: add appropriate tag to each cell"
]
},
{
Expand All @@ -289,7 +289,7 @@
"cell_style": "split"
},
"source": [
"from the cell toolbar\n",
"From the cell toolbar...\n",
"\n",
"![](toolbar-options.png)"
]
Expand Down Expand Up @@ -323,20 +323,28 @@
},
{
"cell_type": "markdown",
"metadata": {},
"metadata": {
"slideshow": {
"slide_type": "notes"
}
},
"source": [
"2 files are loaded without the need for configuring\n",
"\n",
"* `rise.css` in the current directory\n",
"* `README.css` for this notebook because it is called `README.ipynb`\n",
"\n",
"if that works then the cell below has a large border width and a big south-east border-radius"
"If that works then the cell below has a large border width and a big south-east border-radius"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"metadata": {
"slideshow": {
"slide_type": "-"
}
},
"outputs": [],
"source": [
"# sample code cell\n",
Expand All @@ -351,14 +359,14 @@
}
},
"source": [
"# publishing on binder"
"# Publishing on binder"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"in order for a binder-hosted notebook to start in slideshow mode, you need to have the following tag set in the notebook metadata:\n",
"In order for a binder-hosted notebook to start in slideshow mode, you need to have the following tag set in the notebook metadata:\n",
"\n",
"```javascript \n",
" ...\n",
Expand All @@ -377,9 +385,9 @@
}
},
"source": [
"you can edit the notebook metadata from the `edit` menu, submenu `edit notebook metadata`\n",
"You can edit the notebook metadata from the `edit` menu, submenu `edit notebook metadata`.\n",
"\n",
"note finally that the `rise` key in this json file used to be named `livereveal`. the latter is still honored, but the former takes precedence, and it is recommended to use only `rise` from now on"
"Note finally that the `rise` key in this json file used to be named `livereveal`. The latter is still honored, but the former takes precedence, and it is recommended to use only `rise` from now on."
]
},
{
Expand All @@ -390,21 +398,21 @@
}
},
"source": [
"# chalkboard"
"# Chalkboard"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"as an option, you can turn on the *chalkboard* reveal plugin, that manifests itself with 2 extra buttons in the lower left area, that let you add free drawings on your slides"
"As an option, you can turn on the *chalkboard* reveal plugin, that manifests itself with 2 extra buttons in the lower left area, that let you add free drawings on your slides."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"this option is turned on, in the notebook metadata again, with:\n",
"This option is turned on, in the notebook metadata again, with:\n",
"\n",
"```javascript\n",
" ...\n",
Expand Down Expand Up @@ -433,13 +441,11 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.7.2"
"version": "3.7.3"
},
"rise": {
"autolaunch": true,
"enable_chalkboard": true,
"theme": "sky",
"transition": "cube"
"enable_chalkboard": true
}
},
"nbformat": 4,
Expand Down

0 comments on commit 4cd95a6

Please sign in to comment.