{"id":19414735,"url":"https://github.com/cusyio/jupyter-reveal","last_synced_at":"2025-04-24T12:32:06.626Z","repository":{"id":43010056,"uuid":"361686626","full_name":"cusyio/jupyter-reveal","owner":"cusyio","description":"Create Reveal slides with Jupyter Notebooks.","archived":false,"fork":false,"pushed_at":"2024-07-08T14:53:11.000Z","size":29854,"stargazers_count":1,"open_issues_count":2,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-07-08T18:41:13.669Z","etag":null,"topics":["jupyter","reveal-js","slides"],"latest_commit_sha":null,"homepage":"https://slides.cusy.io/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cusyio.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2021-04-26T09:10:30.000Z","updated_at":"2024-06-20T12:05:27.000Z","dependencies_parsed_at":"2023-11-09T16:28:19.501Z","dependency_job_id":"7ef2ac78-f0cc-4e44-9595-311dd128ed3e","html_url":"https://github.com/cusyio/jupyter-reveal","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cusyio%2Fjupyter-reveal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cusyio%2Fjupyter-reveal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cusyio%2Fjupyter-reveal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cusyio%2Fjupyter-reveal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cusyio","download_url":"https://codeload.github.com/cusyio/jupyter-reveal/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223954153,"owners_count":17231182,"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":["jupyter","reveal-js","slides"],"created_at":"2024-11-10T12:39:18.735Z","updated_at":"2024-11-10T12:39:19.532Z","avatar_url":"https://github.com/cusyio.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"Jupyter reveal\n==============\n\nPresentation slides for `Jupyter notebooks \u003chttps://jupyter.org/\u003e`_.\n\n|Contributors| |License| |Pyup|\n\n.. |Contributors| image:: https://img.shields.io/github/contributors/cusyio/jupyter-reveal.svg\n   :target: https://github.com/cusyio/jupyter-reveal/graphs/contributors\n.. |License| image:: https://img.shields.io/github/license/cusyio/jupyter-reveal.svg\n   :target: https://github.com/cusyio/jupyter-reveal/blob/main/LICENSE\n.. |Pyup| image:: https://pyup.io/repos/github/cusyio/jupyter-reveal/shield.svg\n   :target: https://pyup.io/repos/github/cusyio/jupyter-reveal/\n\nMotivation\n----------\n\nWe spent too much time designing our presentation slides using PowerPoint or\nKeynote. Then we needed additional tools for syntax highlighting. Since we were\nalready working a lot with Jupyter notebooks, it was obvious to use them to\ncreate the slides as well.\n\nFeatures\n--------\n\nWrite Markdown\n    In Jupyter notebooks we can use `Markdown Cells\n    \u003chttps://jupyter-notebook.readthedocs.io/en/latest/examples/Notebook/Working%20With%20Markdown%20Cells.html\u003e`_.\nBuilt-in syntax highlighting\n    You get the appropriate syntax highlighting, e.g. for Python with\n\n    .. code-block:: md\n\n        ```python\n        s = \"Syntax Highlighting for Python\"\n        print(s)\n        ```\n\nSupport for mathematical operators and symbols\n    Mathematical operators and symbols are supported with `MathJax\n    \u003chttps://www.mathjax.org/\u003e`_. You can use them in Markdown and code cells.\n    So, e.g. ``$\\sqrt{k}$`` becomes |mathematical operators and symbols| and\n\n    .. |mathematical operators and symbols| image:: img/markdown.png\n\n    .. code-block:: python\n\n        from IPython.display import Math\n        Math(r'F(k) = \\int_{-\\infty}^{\\infty} f(x) e^{2\\pi i k} dx')\n\n    becomes\n\n    .. image:: img/math.png\n\n    However, you can also use other latex modes, e.g. ``eqnarray`` in\n\n    .. code-block:: python\n\n        from IPython.display import Latex\n        Latex(r\"\"\"\\begin{eqnarray}\n        \\nabla \\times \\vec{\\mathbf{B}} -\\, \\frac1c\\, \\frac{\\partial\\vec{\\mathbf{E}}}{\\partial t} \u0026 = \\frac{4\\pi}{c}\\vec{\\mathbf{j}} \\\\\n        \\end{eqnarray}\"\"\")\n\n    becomes\n\n    .. image:: img/latex.png\n\nThemable\n    You can use the `reveal themes \u003chttps://revealjs.com/themes/\u003e`_ or `create\n    your own\n    \u003chttps://github.com/hakimel/reveal.js/blob/master/css/theme/README.md#creating-a-theme\u003e`_.\n\nPDF export\n    The slides can be easily converted to PDFs.\n\nInstallation\n------------\n\n#. Download and unpack:\n\n   .. code-block:: console\n\n    $ curl -O https://codeload.github.com/cusyio/slides/zip/main\n    $ unzip main\n    Archive:  main\n    …\n       creating: slides-main/\n    …\n\n#. Create environment\n\n   .. code-block:: console\n\n        $ cd slides-main\n        $ python3 -m venv .\n        $ . bin/activate\n\n#. Install Python packages:\n\n   .. code-block:: console\n\n        $ python -m pip install -r requirements.txt\n        $ jupyter nbextension enable highlighter/highlighter\n        Enabling notebook extension highlighter/highlighter...\n              - Validating: OK\n\n#. Install the `Jupyter Notebook Extensions\n   \u003chttps://jupyter-contrib-nbextensions.readthedocs.io/\u003e`_ Javascript and CSS\n   files:\n\n   .. code-block:: console\n\n    $ jupyter contrib nbextension install --user\n    jupyter contrib nbextension install --user\n    Installing jupyter_contrib_nbextensions nbextension files to jupyter data directory\n    …\n    Successfully installed jupyter-contrib-core-0.3.3 jupyter-contrib-nbextensions-0.5.1\n    jupyter-highlight-selected-word-0.2.0 jupyter-latex-envs-1.4.6\n    jupyter-nbextensions-configurator-0.4.1\n    …\n    $ jupyter nbextension enable latex_envs --user --py\n    Enabling notebook extension latex_envs/latex_envs...\n          - Validating: OK\n\n#. Start the Jupyter notebook:\n\n   .. code-block:: console\n\n    $  jupyter notebook\n\n#. Turn notebooks into slides with\n   :menuselection:`View --\u003e Cell Toolbar --\u003e Slideshow`\n\n#. Create slides with\n   :menuselection:`File --\u003e Download as --\u003e Reveal.js slides (.slides.html)`\n\n   or\n\n   .. code-block:: console\n\n    $ jupyter nbconvert my-slides.ipynb --to slides --post serve\n\n#. Fix link to cusy styles\n\n   In the generated ``.html`` file you have to insert the link to the CSS file\n   before the body tag:\n\n   .. code-block:: html\n\n    …\n    \u003clink rel=\"stylesheet\" href=\"../dist/theme/cusy.css\" id=\"theme\"\u003e\n    \u003c/head\u003e\n    …\n#. Remove Jupyter styles\n\n   The styles were swapped out to ``dist/theme/jupyter.css`` and then adapted\n   for the Cusy style. Therefore you should delete the style instructions from\n   about line 68–14379 in your HTML file.\n\n#. Create a PDF file:\n\n   #. Open the ``.html`` file\n   #. Add ``?print-pdf`` to the URL.\n   #. Print to PDF with background images.\n\nUpdate styles\n-------------\n\n#. Install Sass\n\n   .. code-block:: console\n\n    $ npm install\n\n    added 860 packages, and audited 927 packages in 3m\n\n    1 low severity vulnerability\n\n    To address all issues, run:\n      npm audit fix\n\n    Run `npm audit` for details.\n\n#. Generate the CSS theme\n\n   .. code-block:: console\n\n    $ npm run build -- css-themes\n\n    \u003e reveal.js@4.1.0 build\n    \u003e gulp \"css-themes\"\n\n    [22:14:52] Using gulpfile ~/cusy/comm/slides/reveal.js/gulpfile.js\n    [22:14:52] Starting 'css-themes'...\n    [22:14:52] Finished 'css-themes' after 64 ms\n\n   This generates the CSS file ``dist/theme/cusy.css``.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcusyio%2Fjupyter-reveal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcusyio%2Fjupyter-reveal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcusyio%2Fjupyter-reveal/lists"}