===========
Version 2.x
===========

ver 2.9.3
=========

:date: 2024-01-13 JST
:base: Reveal.js 5.0.4 (updated)

(None updates for features)

ver 2.9.2
=========

:date: 2023-12-03 JST
:base: Reveal.js 5.0.2

Fixes
-----

* Output script config from ``json.dumps()`` without ``JSON.parse`` in ``<script>``.

ver 2.9.1
=========

:date: 2023-11-25 JST
:base: Reveal.js 5.0.2

Miscellaneous
-------------

* Mark deprecated into ``google_font`` in ``revealjs-slide`` directive.

ver 2.9.0
=========

:date: 2023-11-19 JST
:base: Reveal.js 5.0.2 (updated)

.. note:: This is for last minor update for v2.x

Features
--------

* Set default configuration to disable scroll-view mode for compatibility.

Miscellaneous
-------------

* Update translations.
* Add logging for deprecated.

ver 2.8.0
=========

:date: 2023-10-29 JST
:base: Reveal.js 4.6.1

Features
--------

* Add custom event "revealjs:ready-for-writing" (internal)
* Add optional extension ``sphinx_revealjs.ext.footnotes``.
  See `doc <https://sphinx-revealjs.readthedocs.io/en/stable/optional-extensions/footnotes/>`_ for detail.

Miscellaneous
-------------

* Checked works on Python 3.12
* Use MyPy for type check

ver 2.7.1
=========

:date: 2023-09-29 JST
:base: Reveal.js 4.6.1

Miscellaneous
-------------

* Lock Sphinx version for documentation

ver 2.7.0
=========

:date: 2023-09-29 JST
:base: Reveal.js 4.6.1 (updated)

(None updates for features)

ver 2.6.0
=========

:date: 2023-04-30 JST
:base: Reveal.js 4.5.0 (updated)

Features
--------

* Support custom fragments of Reveal.js 4.5.0 or greater.

  * Include demo updating.

Miscellaneous
-------------

* Checked Sphinx 7.x compatibility.

ver 2.5.1
=========

:date: 2023-01-07
:base: Reveal.js 4.4.0

Fixes
-----

* ``sphinx_revealjs.ext.screenshot`` works only revealjs based builders.

Miscellaneous
-------------

* Update demo

  * Use ``sphinx_revealjs.ext.screenshot`` and ``sphinxext-opengraph``
  * Change structure for i18n

ver 2.5.0
=========

:date: 2022-12-18
:base: Reveal.js 4.4.0

Features
--------

* Add optional extension ``sphinx_revealjs.ext.screenshot``.
  See `doc <https://sphinx-revealjs.readthedocs.io/en/latest/optional-extensions/screenshot/>`_ for detail.

Miscellaneous
-------------

* Extract only target files from archive of Reveal.js.

  * Contain files are not changed
  * It is for CVE-2007-4559

ver 2.4.1
=========

:date: 2022-11-20
:base: Reveal.js 4.4.0

(None updates for features)

Extra
-----

* Fix badge of readme

ver 2.4.0
=========

:date: 2022-11-13
:base: Reveal.js 4.4.0

Added features
--------------

* Add ``data-ln-start-from`` into ``revealjs-code-block`` and ``revealjs-literalinclude``.

Changes
-------

* Demo documentation are changed from ``demo/revealjs4`` to ``demo``.

Deprecated
----------

* Output warning when using it by Python 3.6
* Mark notice level deprecated

  * Change directory for contents of Reveal.js

Change supporting
-----------------

* Add Python 3.11 into supporting
* Drop Python 3.6 from supporting

Development environment
-----------------------

* Hooks of ``pre-commit`` are using as standard linting.
  In GitHub Actions, ``lint`` is running ``pre-commit``.
* Use Flit as building library instead of Poetry.

ver 2.3.0
=========

:date: 2022-10-23
:base: Reveal.js 4.4.0 (updated)

Updated Features
----------------

* Support data-background-gradient correctly (already defined, but not working at older Reveal.js)

ver 2.2.0
=========

:date: 2022-10-01
:base: Reveal.js 4.3.1

Added features
--------------

* Add ``revealjs-literalinclude`` that is extends of ``literalinclude`` for ``data-line-numbers``.
  It is likely ``revealjs-code-block``.

ver 2.1.0
=========

:date: 2022-08-28
:base: Reveal.js 4.3.1

Added Features
--------------

* Package includes SCSS sources of revealjs bundled-themes

Extra
-----

* Use pre-commit

ver 2.0.1
=========

:date: 2022-08-02
:base: Reveal.js 4.3.1

Fixes
-----

* Custom builders accept ``app`` and ``env`` (optional) in initialize function

ver 2.0.0
=========

:date: 2022-05-31
:base: Reveal.js 4.3.1

Added Features
--------------

* Directive ``revealjs-notes`` writes speaker-view content into presentation

* Config ``reveajs_notes_from_comments`` toggle if it creates speaker-view content from comment-block

  * BREAKING CHANGE: Default value is False. You must set ``True`` explicitly to use as same as ver 1.x
* Config ``reveajs_use_index`` toggle if it creates ``genindex.html``

  * BREAKING CHANGE: Default value is False. You must set ``True`` explicitly to use as same as ver 1.x

Fixes
-----

* Register ``data-XXX`` attributes into ``revealjs-section`` and ``revealjs-break`` from https://revealjs.com/

Deleted features
----------------

* Remove snake-case style directives
* Does not generate ``search.html``