sphinx-revealjs

sphinx-revealjs is Sphinx extension to generate Reveal.js presentation documents from standard reStructuredText.

Basic Features

• Nested sections

• Speaker note

• Syntax highlight for Reveal.js (not used pygments)

• Customize slides and sections by conf.py or source reST

Demo

• Source: Sphinx document

• Created: Reveal.js presentation

Concept and motivation

Goal of this library is to provide presentation platform for self-branding of engineer using Sphinx. Using static site hosting service, you can show own presentations to anyone.

Core motivation is that I want to play presentation by this library.

Contents

• Setup
  • Requirements
  • Installation
  • Configuration
  • Build
• Upgrading guide
  • Upgrading from 2.x to 3.x
  • Upgrading from 1.x to 2.x
  • Upgrading from 0.x to 1.x
• Configurations
  • Basic configurations
  • Style Configurations
  • Presentation Configurations
• Directives
  • For customize presentation
  • For customize sections
  • For interactive contents
• Optional extensions
  • Why these are optional ?
  • Usage
  • Features
• Using tips
  • Create custom theme
  • Customizing design simply
• Contributing
  • Conttribute code
• Changelog
  • ver 3.0.1
  • ver 3.0.0
  • Old versions
• Versioning policy
  • Base rules
  • Following dependencies

Licenses

This library is licensed Apache License version 2.0.

About license of directly dependencies, please see each software projects or documentations.

• docutils:

  • https://docutils.sourceforge.io/

• Sphinx:

  • https://www.sphinx-doc.org/

  • https://github.com/sphinx-doc/sphinx

• Reveal.js:

  • https://revealjs.com/#/

  • https://github.com/hakimel/reveal.js

Indices and tables

• Index

• Module Index

• Search Page