Write Markdown or AsciiDoc, present anything
si turns plain Markdown or AsciiDoc into fluid slide decks, articles, tutorials, books, mind maps and code shows: one self-contained HTML file each, no build server, no lock-in.
You write a Markdown or AsciiDoc file. si gives you back a deck that fills any screen, a teleprompter that scrolls with you, an article with a table of contents, a tutorial with steps you can tick, a book with an index, a mind map you can fly into, or a code window whose lines glide from one step to the next. One file in, one HTML file out, and it still opens from a USB stick in ten years.
What you can make#
Decks
Talks that fill any screen, with build steps, animated canvases and a teleprompter. See decks
Articles
One readable page with a table of contents, code, callouts and mind maps in the text. See articles
Tutorials and guides
A folder of pages with a sidebar, numbered steps and a runbook, in Markdown or AsciiDoc. See guides
Mind maps
A nested list you can fold, search and fly into, as boxes, bricks or toys. See mind maps
Books
Chapters, numbered figures and tables, an index and a glossary, printed as one volume. See books
Code windows and shows
Code in a macOS, Windows or terminal window, with callouts and lines that glide between steps. See code
A deck, live#
A mind map, live#
The Thursday Promise#
- Checkout
- Cart & address
- Payment
- Warehouse
- Picking
- Packing
- Delivery
- Route 7
- Doorstep photo
A code show, live#
One attempt
func send(order Order) error {
return client.Post(url, order)
}Retry
func send(order Order) error {
var last error
for try := 1; try <= 5; try++ {
if last = client.Post(url, order); last == nil {
return nil
}
}
return last
}Around them#
Studio
Write, preview, rehearse and present in the browser or the Mac app, with a map editor and a code window builder.
Terminal
The same deck in the terminal, with real pictures, animated canvases and a teleprompter in a second pane.
Presenting
Timers, pace against your last run, mirror, and a phone as clicker, draw pad or teleprompter.
Exports
Every deck, map and code show as a file you can send, print or post.
Publish
A deck becomes a carousel post, an article a post or a full article, always a dry run first.
Themes and fonts
Built-in themes, your own CSS, fonts from Google, Bunny, Fontshare or a file, inlined at build time.
Sites
A folder becomes a site with a navigator, cards, embeds and search, decks and articles side by side.
Checks
Broken links, missing files, click cues that do not match, and pages over their size budget.
Where to go next#
- The features: each kind of document with its example running and the Markdown behind it.
- The rules: every directive, front matter key and fence option, each with an example.
- The manual: the same, as a deck you can present.
- Download: the
sibinary and the Mac app.