https://github.com/ma-gi-cian/hibiscus
A markdown notes application written in electron using react
https://github.com/ma-gi-cian/hibiscus
electron pouchdb react redux
Last synced: about 2 months ago
JSON representation
A markdown notes application written in electron using react
- Host: GitHub
- URL: https://github.com/ma-gi-cian/hibiscus
- Owner: Ma-gi-cian
- Created: 2025-08-30T09:52:59.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-09-14T16:03:08.000Z (10 months ago)
- Last Synced: 2025-09-14T18:18:17.741Z (10 months ago)
- Topics: electron, pouchdb, react, redux
- Language: TypeScript
- Homepage: https://github.com/Ma-gi-cian/Hibiscus
- Size: 409 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Hibiscus
**Hibiscus** is a simple, personal markdown editor built using **Electron**, **React**, and **Vite**. It is inspired by editors like [Marktext](https://marktext.cc) and [Inkdrop](https://inkdrop.app).
>[!Caution]
> This is a learning project and is not intended for production use.
>[!Note]
> This is in a very basic form and will have binaries when a basic implementation is added.
## Key Idea
The key idea for this project was inspired by *Jupiter Notebooks*, where we can write comment blocks in markdown and code in code blocks. But that is only for python.
This is intended for everything, as long as you have the compiler for that language installed in your system.
***Example***
You could have a code block of the following manner:
```javascript
console.log("Hello world")
```
and, the line below will have
`Output: Hello, world`
This feature is intended to makr interactive technical writing much easier - tutorials, documentation, and publishing.
### Getting Started
1. Fork and Install
```bash
git clone https://github.com/your-user-name/Hibiscus.git
cd Hibiscus
npm install
```
2. Run in Development
```bash
npm run dev
```
This will :
- Launch the vite dev server.
- Start electron in development mode.
3. Built for Production ( windows only supported right now )
```bash
npm run dist:win
```
This will run the electron-builder, and create an executable in the dist folder that will be created simultaneously.
#### License
This project currently is licensed under the MIT license.
It is intended as a learning project and not open for contirbution, but feature requests are allowed.
Built with passion and curiosity.