Open in new tab

jupyterlab-deck#

rtd-badge binder-badge ci-badge

Lightweight presentations for JupyterLab

Installation#

pip install jupyterlab-deck

or

mamba install jupyterlab-deck # or conda, if you must

See CONTRIBUTING.md for a development installation.

Usage#

  • Add slide metadata with the Advanced tools

  • When viewing a Notebook, click the deck icon

  • Use the navigation controls or keyboard shortcuts to navigate through the deck

  • Exit the deck with shift+esc

Enabling Deck Mode at startup#

{
  "@deathbeds/jupyterlab-deck:plugin": {
    "active": true
  }
}

Uninstall#

pip uninstall jupyterlab-deck

or

mamba remove jupyterlab-deck # or conda if you must

Changelog#

0.1.0#

  • initial release

Contributing#

Setup#

mamba env update --prefix .venv --file .binder/environment.yml
source activate ./.venv

doit#

The various build tasks are managed by doit. To get up to a ready-to-play JupyterLab:

doit lab

See other available tasks with:

doit list

Open Source#

BSD 3-Clause License

Copyright (c) 2022, jupyterlab-deck contributors
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.

* Neither the name of the copyright holder nor the names of its
  contributors may be used to endorse or promote products derived from
  this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.