About This Site

This website is generated from Markdown files by mdbook, a static site generator.

mdbook competes with similar tools like Retype, Jekyll and Hugo. They are all excellent tools in their own right, but mdbook is slightly more customizable, and can be extended with plugins.

Using this site

The site includes these features:

  • Use the toolbar to collapse the TOC, change the theme, or search site contents.
  • The sidebar on the left provides a list of chapters. Click on a chapter to load it.
  • Click on the page header to jump to the top of that page.
  • Use the arrow buttons on the side of the page to navigate to the previous or next chapter.

The following keyboard shortcuts are supported:

  • Arrow-Left: Navigate to the previous page.
  • Arrow-Right: Navigate to the next page.
  • s: Jump to the search bar (ESC to cancel).
  • t: Jump to the top of the current page.
  • h: Jump to the home page.
  • w: Jump to the schedule.
  • a: Jump to the agenda.

Site configuration

This is a standard mdbook installation with the following third party plugins installed.

Plugins in-use:

  1. mdbook-admonish - admonishments/callouts (examples)
  2. mdbook-embedify - embed videos, content inline
  3. mdbook-image-size - resize and/or align images
  4. mdbook-linkcheck - check if links are valid
  5. mdbook-mermaid - draw Mermaid diagrams
  6. mdbook-toc - add an inline TOC
  7. mdbook-variables - variable substition e.g., instructor name