Onion Reveal coding and documenting

About the project

• Contact: @rhatto
• Chat: #tor-dev on irc.oftc.net
• Video room: to be defined.

Participants

• @rhatto
• @gus
• etc

Summary

This is a proposal to write a reveal.js compiler similar to Onion TeX Slim.

Project A - Writing

The first project in this proposal would be to actually write Onion Reveal. This software could work like this:

• Use a Makefile/script target that traverses a folder looking for .md files.
• Then it would build the HTML slides using a pandoc reveal template.
• With CI/CD for automation, in a way that's easy to integrate into existing projects.
• Localization support.
• With support for QR code generation, so it's easy to embed QR codes into slides.

Examples:

• Files · main · The Tor Project / Web / community · GitLab
• templates/slideshow.html · main · The Tor Project / Web / community
• models/slideshow.ini · main · The Tor Project / Web / community
• assets/static/revealjs/dist/theme/tor.css · community
• Helping Survivors of Domestic Violence

Project B - Trying

• Use this project to build some presentations:
  • Tor Training materials: training#122 (closed).

Related issues:

• Make Tor training slides compatible with Reveal JS format (#268) · community

Examples:

• Tor Project | Helping survivors of domestic violence
• content/training/resources/helping-survivors/contents.lr · community

Skills

Some knowledge in the following technologies may be needed in order to participate:

• Git/GitLab.
• Markdown.
• Writing documentation.
• Basic scripting (Python, shell).

Links