πͺ Using this Book
This book contains all the Nuke π's content in sequence.
It is intended to read from start to finish, in order, and following the index.md
page for each series.
π How to use mdBook
This book is made with mdBook - a Rust native documentation tool. Please give the official docs there a read to see what nice features are included. To name a few key items:
Icon | Description |
---|---|
Opens and closes the chapter listing sidebar. | |
Opens a picker to choose a different color theme. | |
Opens a search bar for searching within the book. | |
Instructs the web browser to print the entire book. | |
Opens a link to the website that hosts the source code of the book. | |
Opens a page to directly edit the source of the page you are currently reading. |
Search
Pressing the search icon () in the menu bar, or pressing the S
key on the keyboard will open an input box for entering search terms.
Typing some terms will show matching chapters and sections in real time.
Clicking any of the results will jump to that section. The up and down arrow keys can be used to navigate the results, and enter will open the highlighted section.
After loading a search result, the matching search terms will be highlighted in the text.
Clicking a highlighted word or pressing the Esc
key will remove the highlighting.
ποΈ How-to use reveal.js
Slides
Most pages include embedded slides that have a lot of handy features.
These are with reveal-md
: a tool built with reveal.js
to allow for Markdown only slides, with a few extra syntax items to make your slides look and feel awesome with very little effort.
π Be use to have the slides
iframe
on a page active (π±οΈ click on it) to use slide keybindings... Otherwise those are captured by themdbook
tools! (s
is search for the book, and speaker notes for the slides)
Be a power user
of these by using the keybindings to interact with them:
- Use
space
to navigate all slides: top to bottom, left to right.- Use
down/up
arrow keys to navigate vertical slides. - Use
left/right
arrow keys to navigate horizontal slides.
- Use
- Press
Esc
oro
to see anoverview
view that arrow keys can navigate. - Press
s
to open up speaker view.
π Speaker notes include very important information, not to be missed!
π« Slides Demo
Tryout those keybindings (π±οΈ click on the slides to start) below:
(π±οΈ expand) Raw Markdown of Slides Content
--- title: How-to use Reveal.js Slides description: How to use reveal.js duration: 5 minuets ---How-to use Reveal.js Slides
These slides are built with reveal.js.
These slides serve as a feature demo of reveal for you! π
What are we going to see:
-
How to use Reveal.js Features
- Useful
reveal.js
tips - Speaker Notes
- Useful
How to use Reveal.js Features
Press the down/up
keys to navigate _vertical slides_
Try doing down a slide.
---v
Use the keybindings!
-
Overview mode: βOβ to see a birds-eye view of your presentation, βESCβ to return to the highlighted slide (you can quickly navigate with arrows)
-
Full-screen: βFβ, βESCβ to exit full-screen mode
-
Speaker mode: βSβ it synchronizes 2 windows: one with the presentation, and another with a timer and all speaker notes!
-
Zoom-in: ALT+click make the view zoom at the position of your mouseβs pointer; very useful to look closely at a picture or chart surrounded by too much bullet points.
---v
Speaker Notes & Viewer
Press the s
key to bring up a popup window with speaker view
You need to unblock popups to have the window open
Notes:
This is a note just for you. Set under a line in your slide starting with "Note
:" all
subsequent lines are just seen in speaker view.
Enjoy!
π
βοΈ All slides Slides Content
is available on all pages.
This enables search to work throughout this book to jump-to-location for any keywords you remember related to something covered in a topic π.