- 13 Commits
- 14 Pushes
- 0 Deploys
- 5 Votes
hansolo
Passionate Full-stack Developer · Vim lover · germinating code from the inside
Team Members
-
Cristian Cortez San Francisco
Entry URL
node-book
Interactive NodeJS Notebook cli-tool
Description
Rationale
Notes help us think, document, experiment and play with ideas. That's the main reason for creating this project. I'm a big fan of jupyter notebooks, gists, pastebins and cloud documents but I'm still searching for something better to comunicate, express myself and save my JS notes.
Installation
Install the command line cli-tool to have a better experience:
$ npm i -g jsnotebook2
$ jsnotebook2
Examples
- Insert math formulas, like the following:
\sum i = 1 + 2 + 3 + ... + n - Execute javascript code rows by pressing
shift+enterduring edition, you can repeat this operation multiple times and receive the updatedstdout,stderr - To take the most out of the experience you might consider looking into markdown and mathjax language references
Credits
Developed by Cristian Cortez cortez.cristian[at]gmail.com
- Twitter @cortezcristian
- LinkedIn Profile
- Github Profile
Special thanks to https://www.nodeknockout.com/ that challenges and inspires me to get creative every year
Instructions
Usage
Here's a basic description of the capabilities
- Select the row type and hit the plus (+) button on the toolbar to create new rows: Markdown, Mathajax, Code
- You can use the arrow keys (
upanddown) to move between cells, hitshift+enterfor edition andescto escape edition mode - The row selected will be highlighted in
blueand the cell under edition ingreen - You can move rows to a different position in the document, using the up and down buttons in the tool bar
- Also you can perform cut , copy , paste and remove operations on the selected row
- Notebook can be printed and source code be downloaded as json by clicking the download button
- All of your changes are automatically persisted to your browser local storage
- Click the save floppy disk button to restore a previous session or copy source to your clipboard
View the screencast:
https://www.youtube.com/watch?v=pal4cDvTmzI&feature=youtu.be
Built With
Dependencies
This package uses
- vm2 to create a secure sandbox vm to digest nodejs code
- express to mount a web server via cli and serve static files
- body-parser to parse incoming request bodies source code
- opener to open a new tab in your favorite browser
Feedback / Ratings (4)
All Feedback
-
2018-10-29T20:21:31ZTravis Horn (Participant)
I like stuff like this. Technical style notebook. I could see it being very useful with more powerful features.
-
-
-
2018-11-04T16:06:01ZBrian Woodward (Judge)
I've wanted something like this in the node.js world and I think this is a really good start. I think some improvements can be made in how code is executed to allow "resetting" the notebook environment and using a `require` statement.
Overall, I think it looks really good and is something that I would use.
-
-
2018-11-04T19:50:41Z
Ethan Garofolo (Judge)
Very nicely done, and very polished look. I really like the support for math formulas. This is fantastic work for a 48-hour hackathon, and I could totally see this being taken further into a OneNote/Evernote competitor.
-
2018 Important Dates
Partners
More Sponsors
Cristian Cortez
I'm glad you liked it, thanks for the feedback