https://github.com/atsphinx/revealjs-rtd

https://github.com/atsphinx/revealjs-rtd

Last synced: 5 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/atsphinx/revealjs-rtd
• Owner: atsphinx
• License: apache-2.0
• Created: 2024-10-16T16:53:46.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-17T19:08:47.000Z (over 1 year ago)
• Last Synced: 2025-09-25T13:05:33.652Z (9 months ago)
• Language: JavaScript
• Size: 163 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
=====================

atsphinx-revealjs-rtd

=====================

Optimize for sphinx-revealjs on Read the Docs

Overview

========

This has plugin for Reveal.js to optimize presentation on Read the Docs.

You will be able to well done about manage presentation on RTD.

Getting started

===============

.. code:: console

   pip install atsphinx-revealjs-rtd

.. code:: python

   extensions = [

       ...,  # Your extensions

       "atsphinx.revealjs_rtd",

   ]

Usage

=====

This does not have features as Python works, have only providing Reveal.js plugin.

- You can toggle versioning widget of RTD by pressing 'D' key.

- (ToDo) It suppresses Reveal.js shortcut when you searching on widget of RTD.