{"id":28273692,"url":"https://github.com/attakei/sphinx-revealjs","last_synced_at":"2025-12-25T22:33:34.782Z","repository":{"id":33556715,"uuid":"155326266","full_name":"attakei/sphinx-revealjs","owner":"attakei","description":"HTML Presentation builder for Pythonista","archived":false,"fork":false,"pushed_at":"2025-04-04T02:11:28.000Z","size":5182,"stargazers_count":118,"open_issues_count":17,"forks_count":21,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-05-21T00:19:47.944Z","etag":null,"topics":["hacktoberfest","presentation-tools","reveal-js","sphinx","sphinx-extension"],"latest_commit_sha":null,"homepage":"https://attakei.github.io/sphinx-revealjs/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/attakei.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":"CONTRIBUTING.rst","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"attakei"}},"created_at":"2018-10-30T04:52:01.000Z","updated_at":"2025-05-18T12:43:07.000Z","dependencies_parsed_at":"2023-10-02T02:42:15.730Z","dependency_job_id":"2b8f9727-c7bc-4b56-b02c-e28cc3f2934c","html_url":"https://github.com/attakei/sphinx-revealjs","commit_stats":{"total_commits":664,"total_committers":10,"mean_commits":66.4,"dds":0.3087349397590361,"last_synced_commit":"c7826a69123eba3773ff460ab79649625ef75f41"},"previous_names":[],"tags_count":56,"template":false,"template_full_name":null,"purl":"pkg:github/attakei/sphinx-revealjs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/attakei%2Fsphinx-revealjs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/attakei%2Fsphinx-revealjs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/attakei%2Fsphinx-revealjs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/attakei%2Fsphinx-revealjs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/attakei","download_url":"https://codeload.github.com/attakei/sphinx-revealjs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/attakei%2Fsphinx-revealjs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260039627,"owners_count":22949652,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest","presentation-tools","reveal-js","sphinx","sphinx-extension"],"created_at":"2025-05-21T00:19:15.510Z","updated_at":"2025-12-25T22:33:34.720Z","avatar_url":"https://github.com/attakei.png","language":"Python","funding_links":["https://github.com/sponsors/attakei"],"categories":["Presentation"],"sub_categories":[],"readme":"sphinx-revealjs\n===============\n\n.. image:: https://img.shields.io/pypi/v/sphinx-revealjs.svg\n    :target: https://pypi.org/project/sphinx-revealjs/\n\n.. image:: https://github.com/attakei/sphinx-revealjs/actions/workflows/main.yml/badge.svg\n    :target: https://github.com/attakei/sphinx-revealjs/actions\n\n.. image:: https://readthedocs.org/projects/sphinx-revealjs/badge/?version=latest\n    :target: https://sphinx-revealjs.readthedocs.io/en/latest/?badge=latest\n    :alt: Documentation Status\n\nSphinx extension with theme to generate Reveal.js presentation\n\nOverview\n--------\n\nThis extension generate Reveal.js presentation\nfrom **standard** reStructuredText.\n\nIt include theses features.\n\n* Custom builder to translate from reST to reveal.js style HTML\n* Template to be enable to render presentation local independent\n\nFor more information, refer to `the documentation \u003chttps://sphinx-revealjs.readthedocs.io/\u003e`_.\n\nInstallation\n------------\n\n.. code-block:: bash\n\n    $ pip install sphinx-revealjs\n\n\nUsage\n-----\n\n1. Create your sphinx documentation\n2. Edit `conf.py` to use this extension\n\n    .. code-block:: python\n\n        extensions = [\n            'sphinx_revealjs',\n        ]\n\n3. Write source for standard document style\n\n4. Build sources as Reveal.js presentation\n\n    .. code-block:: bash\n\n        $ make revealjs\n\nChange logs\n-----------\n\nSee `it \u003c./CHANGELOG.rst\u003e`_\n\nPolicy for following to Reveal.js version\n-----------------------------------------\n\nThis is implemented based Reveal.js.\nI plan to update it at patch-version for catch up when new Reveal.js version released.\n\n* If Reveal.js updated minor or patch version, sphinx-revealjs update patch version.\n* If Reveal.js updated major version, sphinx-revealjs update minor version with compatible for two versions.\n\nContributing\n------------\n\nGitHub repository does not have reveal.js library.\n\nIf you use from GitHub and editable mode, Run ``tools/fetch_revealjs.py`` after install.\n\n.. code-block:: bash\n\n    $ git clone https://github.com/attakei/sphinx-revealjs\n    $ cd sphinx-revealjs\n    $ python tools/fetch_revealjs.py\n\nFor more information, See `CONTRIBUTING.rst \u003c./CONTRIBUTING.rst\u003e`_ and `\"contributing\" \u003chttps://sphinx-revealjs.readthedocs.io/en/stable/contributing/\u003e`_ page in documentation.\n\nCopyright\n---------\n\nApache-2.0 license. Please see `LICENSE \u003c./LICENSE\u003e`_.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fattakei%2Fsphinx-revealjs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fattakei%2Fsphinx-revealjs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fattakei%2Fsphinx-revealjs/lists"}