Browse Source

Clarifies exporting, and adds clarification on reveal.js slides workflow. Closes #5018

Duarte OC 6 years ago
parent
commit
a6e3896c97

+ 1 - 0
docs/source/index.rst

@@ -41,6 +41,7 @@ JupyterLab is the next-generation web-based user interface for Project Jupyter.
    user/file_formats
    user/extensions
    user/jupyterhub
+   user/export
 
 
 .. toctree::

+ 48 - 0
docs/source/user/export.rst

@@ -0,0 +1,48 @@
+.. _user_export:
+
+Exporting Notebooks
+-------------------
+
+JupyterLab allows you to export your jupyter notebook files (``.ipynb``)
+into other file formats such as:
+
+-  Asciidoc ``.asciidoc``
+-  HTML ``.html``
+-  Latex ``.tex``
+-  Markdown ``.md``
+-  PDF ``.pdf``
+-  ReStructured Text ``.rst``
+-  Executable Script ``.py``
+-  Reveal.js Slides ``.html``
+
+To access these options, while a notebook is open, browse the File menu:
+
+.. image:: images/exporting_menu.png
+   :align: center
+   :class: jp-screenshot
+
+.. _user_export_revealjs:
+
+Reveal.js Slides
+~~~~~~~~~~~~~~~~
+In order to export your notebooks as `Reveal.js <https://github.com/hakimel/reveal.js>`__
+slides, follow these steps:
+
+1. Open a notebook by double clicking it in the
+   :ref:`file browser <working-with-files>`.
+2. Select Cell tools in the :ref:`left sidebar <left-sidebar>`.
+3. Select the slide type (Slide, Subslide, Fragment, Skip, Notes).
+
+.. image:: images/exporting_slide_type.png
+   :align: center
+   :class: jp-screenshot
+
+4. Activate another cell.
+5. Repeat 3 and 4 until you selected the slide type for all of your cells.
+
+After completing these steps, browse the file menu and export as described in
+the :ref:`exporting notebooks <user_export>` section. A ``.html`` file that
+you will be prompted to download.
+
+If you don't know how to navigate and interact with a Reveal.js presentation,
+visit the project's `website <https://github.com/hakimel/reveal.js>`__.

BIN
docs/source/user/images/exporting_menu.png


BIN
docs/source/user/images/exporting_slide_type.png