ソースを参照

Add a bit of examples documentation

Carol Willing 8 年 前
コミット
0fb2d6aee6
2 ファイル変更28 行追加1 行削除
  1. 27 0
      tutorial/examples.md
  2. 1 1
      tutorial/index.rst

+ 27 - 0
tutorial/examples.md

@@ -0,0 +1,27 @@
+# Examples of Plugins
+
+The `examples` directory in the JupyterLab repo contains:
+- several stand-alone plugin examples (`console`, `filebrowser`, `notebook`,
+ `terminal`)
+- a more complex example using multiple plugins (`lab`).
+
+Installation instructions for the examples are found in the project's README.
+
+After installing the jupyter notebook server 4.2+, follow the steps for
+installing the development version of JupyterLab. To build the examples, enter
+from the ``jupyterlab`` repo root directory, ``npm run server:examples``.
+
+To run a particular plugin, navigate to the plugin's subdirectory in the
+``examples`` directory. Enter: ``python main.py``.
+
+## Stand-alone plugins
+
+### console
+
+### filebrowser
+
+### notebook
+
+### terminal
+
+## Complex example using multiple plugins

+ 1 - 1
tutorial/index.rst

@@ -23,7 +23,7 @@ Contents:
    documents.md
    notebook.md
    patterns.md
-
+   examples.md
 
 Indices and tables
 ==================