Skip to content

Commit f79c868

Browse files
committed
update doc and remove unnecessary files
1 parent 513916d commit f79c868

File tree

5 files changed

+7
-31
lines changed

5 files changed

+7
-31
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# nbchrome
22
A lightweight viewer for Jupyter Notebooks as a Chrome Extension.
33
This project differentiates from Jupyter Notebook Viewer by not requiring any server process.
4+
No data is sent or received over the network by the plugin.
45

56
**Note: This project is currently at the proof-of-concept phase and some functionality may be missing.
67
I would appreciate pull requests or git issues.**
@@ -11,10 +12,12 @@ I would appreciate pull requests or git issues.**
1112

1213
Installation:
1314
1. Download to a local folder.
14-
2. Go to chrome://extensions and enable developer mode in the top-right corner.
15-
3. Click 'Load unpacked' from the top-left corner and select the extension.
16-
4. Open any .ipynb file in Chrome.
17-
5. If you edit or update the extension, hit the reload button for the extension in the extension manager.
15+
2. Install nodejs
16+
3. npm install
17+
4. npm build-dev
18+
5. Go to chrome://extensions and enable developer mode in the top-right corner.
19+
6. Click 'Load unpacked' from the top-left corner and select the extension folder.
20+
7. Open any .ipynb file in Chrome.
1821

1922
At the moment, if you hit an error it's probably because of some element that the script isn't handling.
2023
If this happens it will probably just show you the raw json and look like nothing else happened.

highlight/highlight.min.js

Lines changed: 0 additions & 2 deletions
This file was deleted.

mathjax/tex-chtml.js

Lines changed: 0 additions & 1 deletion
This file was deleted.

showdown/LICENSE

Lines changed: 0 additions & 21 deletions
This file was deleted.

showdown/showdown.min.js

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)