https://github.com/sidmohanty11/jsnotion

A code documenting application that can 10x your productivity while learning to code.
https://github.com/sidmohanty11/jsnotion

cli code-editor command-line commander documentation-tool express ide react reactjs redux typescript

Last synced: 2 months ago
JSON representation

A code documenting application that can 10x your productivity while learning to code.

• Host: GitHub
• URL: https://github.com/sidmohanty11/jsnotion
• Owner: sidmohanty11
• License: mit
• Created: 2021-12-01T17:52:43.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-10-02T11:29:30.000Z (about 2 years ago)
• Last Synced: 2023-03-03T23:01:58.870Z (almost 2 years ago)
• Topics: cli, code-editor, command-line, commander, documentation-tool, express, ide, react, reactjs, redux, typescript
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/jsnotion
• Size: 4.03 MB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
jsnotion




  



  



  



A code documenting application that can 10x your productivity while learning to code.

## Installation

Assuming you have Node and npm installed,

```

npx jsnotion serve

```

is the only command you need to get started instantly.

Otherwise, if you are a visionary and you see yourself using it frequently,

```

npm install -g jsnotion

```

this will install jsnotion globally so that you can use it anytime you like, from the terminal.

Now, more on the commands:-

```

jsnotion serve

```

This is your goto command which will start a server at http://localhost:3005 and create/open a notebook.js file in your current directory to save all your notes.

```

jsnotion serve notes.js -p 4000

```

This is a more personalized command you can use to create/open a file of your choice, in this case, notes.js and also the port of your choice i.e, 4000 here.

## Usage

https://user-images.githubusercontent.com/73601258/147817907-1bbbc6c5-e1e5-4396-b025-a67111e063e3.mp4

While this is a short preview of the application, in no way it shows all the capabilities of jsnotion. You can import anything (just about anything) and run it in your editor. Some examples include - making axios calls, importing CSS libraries, etc. React is prebuilt and you can use the `show()` function to display anything in your preview window.

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.