slidedown presentation

 ____  _     ___ ____  _____ ____   _____        ___   _ 
/ ___|| |   |_ _|  _ \| ____|  _ \ / _ \ \      / / \ | |
\___ \| |    | || | | |  _| | | | | | | \ \ /\ / /|  \| |
 ___) | |___ | || |_| | |___| |_| | |_| |\ V  V / | |\  |
|____/|_____|___|____/|_____|____/ \___/  \_/\_/  |_| \_|

Text-first presentation compiler with behavioral markup.

View as Interactive Presentation:
https://fnndsc.github.io/slidedown/readme-presentation/

Documentation: docs/

Examples: examples/

git clone https://github.com/FNNDSC/slidedown
cd slidedown
make dev

Then compile and serve an example:

make presentation SOURCE=examples/minimal/minimal.sd
# Open http://localhost:8000

Without make, use the slideshow script directly:

./slideshow examples/minimal/minimal.sd --theme conventional-light

Or the raw CLI:

python3 -m venv .venv
.venv/bin/pip install -e ".[dev]"
slidedown examples/minimal/ output/ --inputFile minimal.sd
cd output/ && python3 -m http.server 8000

The core syntax is simple:

.directive{content}
.directive{\.modifier{value} content}
.directive{nested \.directives{work} too}

Structure:

.slide{} — defines a slide

.title{} — slide title

.body{} — slide content

.slide{
  \.title{My First Slide}
  \.body{
    \.typewriter{> Initializing...}

    \.bf{Features:}
    \.o{\.em{Text-first} authoring}
    \.o{\.tt{Behavioral} markup}
    \.o{Interactive \.bf{effects}}
  }
}

# Compile and serve
make presentation SOURCE=examples/minimal/minimal.sd

# Change theme or port
make presentation SOURCE=deck.sd THEME=retro-terminal PORT=9000

# Compile only (no server)
make compile SOURCE=deck.sd

# Serve an already-compiled deck
make serve SOURCE=deck.sd

Via slideshow script:

./slideshow path/to/deck.sd --theme lcars-lower-decks
./slideshow path/to/deck.sd --no-serve --outputdir /tmp/out

Direct CLI:

slidedown inputdir/ outputdir/ --inputFile deck.sd --theme terminal

See all Makefile targets:

make help

slidedown/
├── src/
│   ├── lib/
│   │   ├── parser.py        # .sd syntax parser
│   │   ├── compiler.py      # AST → HTML compiler
│   │   ├── directives.py    # Directive implementations
│   │   ├── theme.py         # Theme loader
│   │   └── theme_base.py    # Theme hook system
│   └── models/              # Type definitions
├── themes/                  # 5 built-in themes
├── assets/                  # CSS, JS, HTML templates
├── docs/                    # Docs + hosted presentations
├── examples/                # Example .sd decks
└── tests/                   # 97 tests

# Run all tests
make test

# Specific file
pytest tests/test_parser_basic.py -v

# With coverage
make coverage

97 tests across 5 files:

test_parser_basic — directive parsing

test_parser_modifiers — .style{} and .class{} extraction

test_parser_nesting — recursive structure

test_parser_escaping — escape sequences

test_e2e_compilation — full pipeline

Functional pipeline:

.sd source → Parser → AST → Compiler → HTML
               ↓         ↓        ↓
          ProgramState → → → → → →

State Bus — ProgramState dataclass carries pipeline state

Inside-Out Compilation — children compiled before parents

Theme Hook System — themes subclass ThemeHooks for custom layouts

Directive Registry — extensible, add new directives easily

    __  _____________
   /  |/  /  _/_  __/
  / /|_/ // /  / /   
 / /  / // /  / /    
/_/  /_/___/ /_/

Licensed under the MIT License. See LICENSE file for details.

Author: Rudolph Pienaar Issues: github.com/FNNDSC/slidedown/issues