diff --git a/README.md b/README.md index ef2e7ee50..162b2c3f6 100755 --- a/README.md +++ b/README.md @@ -91,7 +91,11 @@ In JupyterLab, Jupytext adds a set of commands to the command palette: ![JupyterLab extension](https://raw.githubusercontent.com/mwouts/jupyterlab-jupytext/master/jupytext_commands.png) -The Jupytext extension for JupyterLab is bundled with Jupytext. Installing Jupytext will trigger a build of JupyterLab the next time you open it. If you prefer, you can trigger the build manually with +The lab extension is included in the Python package. Unless you need to use an older version of the extension you don't have to either install or update the extension manually from [npm](https://www.npmjs.com/). + +If you are wondering why the npm and the Python packages have different version, it's because the npm package is updated less often than the Python one. The latest versions are respectively [![npm version](https://badge.fury.io/js/jupyterlab-jupytext.svg)](https://badge.fury.io/js/jupyterlab-jupytext) and [![Pypi](https://img.shields.io/pypi/v/jupytext.svg)](https://pypi.python.org/pypi/jupytext). + +Installing Jupytext will trigger a build of JupyterLab the next time you open it. If you prefer, you can trigger the build manually with ``` jupyter lab build ``` diff --git a/packages/labextension/CHANGELOG.md b/packages/labextension/CHANGELOG.md index 23bbcf34a..db8a36534 100644 --- a/packages/labextension/CHANGELOG.md +++ b/packages/labextension/CHANGELOG.md @@ -1,3 +1,8 @@ +# 1.1.0 (2019-11-03) + +- The documentation includes the last version numbers for both Jupytext Python and for this extension (#311) +- Documentation says clearly that the extension is bundled with the Python package (#350) + # 1.0.2 (2019-07-18) - Fixed an incorrect `target_format` entry inserted by the version 1.0.1 of the extension. diff --git a/packages/labextension/README.md b/packages/labextension/README.md index f80f3855c..f232a2f48 100644 --- a/packages/labextension/README.md +++ b/packages/labextension/README.md @@ -2,11 +2,18 @@ This extension adds a few [Jupytext](https://github.com/mwouts/jupytext) commands to the command palette. Use these to select the desired ipynb/text pairing for your notebook. -![Jupytext commands](jupytext_commands.png) +The latest version for this extension is [![npm version](https://badge.fury.io/js/jupyterlab-jupytext.svg)](https://badge.fury.io/js/jupyterlab-jupytext). + +Most users do not need to install this extension, since it is already included in the latest [jupytext](https://github.com/mwouts/jupytext/), both on [![Pypi](https://img.shields.io/pypi/v/jupytext.svg)](https://pypi.python.org/pypi/jupytext) and +[![Conda Version](https://img.shields.io/conda/vn/conda-forge/jupytext.svg)](https://anaconda.org/conda-forge/jupytext). + +![](https://github.com/mwouts/jupytext/raw/master/packages/labextension/jupytext_commands.png) ## Installation -Please [install Jupytext](https://github.com/mwouts/jupytext/blob/master/README.md#installation) first. The Jupytext extension for JupyterLab is bundled with Jupytext. Installing Jupytext will trigger a build of JupyterLab the next time you open it. If you prefer, you can trigger the build manually with +Please install [Jupytext](https://github.com/mwouts/jupytext/blob/master/README.md#installation) first. As mentioned above, both the `pip` and `conda` packages do include the latest version of the JupyterLab extension, so in most cases you don't need to specifically install this `npm` package. + +Installing Jupytext will trigger a build of JupyterLab the next time you open it. If you prefer, you can trigger the build manually with ```bash jupyter lab build