GitHub: https://github.com/AlpyneDreams/NotesApp
You will need Node.js installed.
You may use npm but the project was developed with yarn, so use that if you have any issues.
To run:
yarn install
yarn start
(or npm equivalent)
Notebooks are stored as subfolders of the notes
folder in the pwd.
Implemented
- Organize markdown notes in notebooks linked to folders
- Apply all the core types of markdown formatting
- Paste images directly from your clipboard
- Search note contents for keywords or phrases
- Code blocks with syntax highlighting
- LaTeX math rendering
- Open multiple tabs
Planned
- Dark Mode - wip on
dark-theme
branch - Note Categories
- Sticky Notes view
- Tables
- Autosave
- Notebook icons
- Encrypted notebooks
- Sorting notes
Detailed info is in package.json
. Yarn will install all needed dependencies for you.
The main ones are:
- Electron
- Electron Forge
- makers: deb, rpm, squirrel, zip
- plugin-webpack
- electron-squirrel-startup
- Electron Forge
- React.js
- react-dom
- react-reorder
- markdown-it
- markdown-it-front-matter
- markdown-it-highlightjs
- markdown-it-katex
- turndown
- Webpack
- hotkeys.js
Webpack plugins used: (mainly: sass, pug, babel)
Bundled dependencies (not managed by yarn):