瀏覽代碼

Update README.md

Ian Rose 7 年之前
父節點
當前提交
4ded86bb2a
共有 2 個文件被更改,包括 11 次插入8 次删除
  1. 11 8
      packages/toc/README.md
  2. 二進制
      packages/toc/toc.gif

+ 11 - 8
packages/toc/README.md

@@ -1,11 +1,16 @@
 # jupyterlab-toc
 
-Table of Contents extension for JupyterLab
+A Table of Contents extension for JupyterLab.
+This auto-generates a table of contents in the left area when you have a notebook
+or markdown document open. The entries are clickable, and scroll the document
+to the heading in question.
+
+![Table of Contents](toc.gif "Table of Contents")
 
 
 ## Prerequisites
 
-* JupyterLab
+* JupyterLab v0.31
 
 ## Installation
 
@@ -18,15 +23,13 @@ jupyter labextension install jupyterlab-toc
 For a development install (requires npm version 4 or later), do the following in the repository directory:
 
 ```bash
-npm install
-npm run build
-jupyter labextension link .
+jlpm install
+jlpm run build
+jupyter labextension install .
 ```
 
 To rebuild the package and the JupyterLab app:
 
 ```bash
-npm run build
+jlpm run build
 jupyter lab build
-```
-

二進制
packages/toc/toc.gif