overview.rst 3.2 KB

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