TypoVibe is a minimalistic Text editor. It's not much but it's something.
My approach is a little complicated and for this version probably too much but I have big plans for the future so I went with this.
The main process is basically just a simple electron app, starting the application with the window and sets the necessary attributes, such as the application icon or the window title.
The renderer process is started when the main process has finished setting up everything about the window.
There's an internal server running with which the frontend (i.e. the renderer process) is communicating. I went with this approach so other contributers can easily access the same interface, no matter how they do it. Using the electron IPC workflow, a few issues would arise in which case the whole project would have to be rewritten. The default port for the internal server is 13395 (can be changed in the settings.json).
The internal server writes and reads to and from the settings.json/session.json
Ctrl + S- Save NoteCtrl + K- Open Command paletteCtrl + T- Focus titleCtrl + B- Focus bodyCtrl + P- Toggle Markdown Preview
Please refer to commands.js to view all commands in json format
Command Palette- to execute all commands within secondsMarkdown Preview- to properly design markdown fitting to your needsAuto-Save- so you never lose your stuffSession-based- take off where you left last time
Currently, there are two color themes available (light/dark) but i'm planning on implementing a lot more cool color themes.
- Node.js (version 14.x or higher)
- npm (version 6.x or higher)
To get started, fork the repository and then clone it locally:
git clone https://github.com/{username}/typovibe.git
cd typovibeInstall the required npm packages:
npm installTo build the application for Linux, use the following command:
npm run makeThe build artifacts will be located in the out directory.
To start the application in development mode:
npm startThis will build the tailwind css and launch the application.
We welcome contributions from the community! To contribute:
- Fork the repository.
- Create a new branch for your feature or bugfix.
- Make your changes.
- Commit and push your changes.
- Open a pull request. Please make sure to follow the code style.
This project is licensed under a Custom License. See the LICENSE file for more details.
For any questions or feedback, feel free to open an issue or contact the maintainer at help@typovibe.com
Thank you for using TypoVibe!