The rules

The rules

Everything si understands, with an example for each rule. si rules prints this file; examples/showcase.md uses every rule in a real talk.

AsciiDoc too. A deck can be *.adoc / *.asciidoc instead of *.md; si converts the AsciiDoc to this same format and everything below applies. See docs/asciidoc.md for the supported subset.

The layout rule. Slides are fluid and responsive, never fixed. There is no 1280×720 canvas scaled by a transform: every slide fills the viewport and reflows, type follows the slide size (container units and clamp()), two columns stack on narrow or portrait screens, SVGs scale by their viewBox. A deck must read well from a ~400 px phone to a 4K display, in portrait and landscape. Image widths take %, em or cqi; px sizes are refused.

Contents#

  1. Decks and files
  2. Front matter
  3. Slides and headings
  4. Directives
  5. Layouts and columns
  6. Transitions
  7. Backgrounds
  8. Images
  9. Build steps
  10. Animated SVG canvases
  11. Speaker notes and the teleprompter
  12. Includes
  13. Code, Mermaid, tables, links
  14. Presenting: keys, touch, overview, print
  15. Styling: themes and your own CSS
  16. Configuring keys and features (si.conf)
  17. What si check reports
  18. Lab documents
  19. Articles
  20. Guides (tutorials)
  21. Books (references)
  22. Demo scripts
  23. Sites
  24. Mind maps

Sections#