Skip to content

HimathR/notejs-web

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

42 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Welcome To NoteJS!

About NoteJS

This is a JavaScript + Markdown editor inspired by Jupyter Notebook. This repository contains the web version of NoteJS which lacks proper data persistence but can still quickly showcase the basic functionalities of the app. Any data written into the markdown or code editor can be exported in json format with the "Export Data" button at the bottom of the page. This json file can then be easily loaded and imported into the npx version of the app too.

Usage

The app is deployed at the following site: https://notejs.himathsprojects.xyz/
A link to the npx version of this project can be found at this repo: https://github.com/HimathR/notejs.
Anyone can have the npx version running straight away by simply running npx himath-notejs-cli serve on a terminal that has npm installed!

Tech Stack & Features

This project is written React + TypeScript with Redux being used for state management. The project also utilises Atlassian's Design system for component styling and modals. Bundling is carried out using ESBuild, allowing for super speedy code execution

The code editor used is the Monaco Editor and includes formatting using prettier, as well as some custom functions. Currently, these include:

  • show(variable) which allows users to show a variable in the sandboxed iframe, rather than cumbersomely console logging and checking devtools
  • recolor("colour") which allows users to change the colour of the iframe output to their desired choice

Moreover, just like Jupyter notebook, NoteJS can handle consecutive code execution. For example, if you declare a variable in cell A, then you can still access that variable in cell B, allowing for a more convenient user experience. NoteJS is also able to handle some basic imports, including previewing of React components and CSS.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published