overview.rst 2.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. .. _overview:
  2. Overview
  3. --------
  4. JupyterLab is the next-generation web-based user interface for Project Jupyter.
  5. .. image:: ../user/images/interface_jupyterlab.png
  6. :align: center
  7. :class: jp-screenshot
  8. JupyterLab enables you to work with documents and activities such as
  9. :ref:`Jupyter notebooks <notebook>`, text editors, terminals, and custom
  10. components in a flexible, integrated, and extensible manner. You can
  11. :ref:`arrange <interface>` multiple documents and activities side by side in the
  12. work area using tabs and splitters. Documents and activities integrate with each
  13. other, enabling new workflows for interactive computing, for example:
  14. - :ref:`code-console` provide transient scratchpads for running code
  15. interactively, with full support for rich output. A code console can be
  16. linked to a notebook kernel as a computation log from the notebook, for
  17. example.
  18. - :ref:`Kernel-backed documents <kernel-backed-documents>` enable code in any
  19. text file (Markdown, Python, R, LaTeX, etc.) to be run interactively in any
  20. Jupyter kernel.
  21. - Notebook cell outputs can be :ref:`mirrored into their own tab <cell-output-mirror>`,
  22. side by side with the notebook, enabling simple dashboards with interactive controls
  23. backed by a kernel.
  24. - Multiple views of documents with different editors or viewers enable live
  25. editing of documents reflected in other viewers. For example, it is easy to
  26. have live preview of :ref:`markdown`, :ref:`csv`, or :ref:`vega-lite` documents.
  27. JupyterLab also offers a unified model for viewing and handling data formats.
  28. JupyterLab understands many file formats (images, CSV, JSON, Markdown, PDF,
  29. Vega, Vega-Lite, etc.) and can also display rich kernel output in these formats.
  30. See :ref:`file-and-output-formats` for more information.
  31. To navigate the user interface, JupyterLab offers :ref:`customizable keyboard
  32. shortcuts <shortcuts>` and the ability to use :ref:`key maps <editor-keymaps>`
  33. from vim, emacs, and Sublime Text in the text editor.
  34. JupyterLab :ref:`extensions <user_extensions>` can customize or enhance any part
  35. of JupyterLab, including new themes, file editors, and custom components.
  36. JupyterLab is served from the same `server
  37. <https://jupyter-notebook.readthedocs.io/en/stable/>`__ and uses the same
  38. `notebook document format <http://nbformat.readthedocs.io/en/latest/>`__ as the
  39. classic Jupyter Notebook.
  40. .. _releases:
  41. JupyterLab Releases
  42. ~~~~~~~~~~~~~~~~~~~
  43. The current release of JupyterLab is suitable for general daily use.
  44. The extension developer API is evolving, and we also are currently iterating on UI/UX improvements.
  45. We appreciate feedback on our `GitHub issues page <https://github.com/jupyterlab/jupyterlab/issues>`__
  46. as we evolve towards a stable extension development API.
  47. JupyterLab will eventually replace the classic Jupyter Notebook.
  48. Throughout this transition, the same notebook document format will be supported by both the classic Notebook and JupyterLab.