Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/IceEnd/Yosoro

:shaved_ice:Beautiful Markdown NoteBook. 🏖
https://github.com/IceEnd/Yosoro

electron latex markdown notebook onedrive react

Last synced: about 1 month ago
JSON representation

:shaved_ice:Beautiful Markdown NoteBook. 🏖

Awesome Lists containing this project

README

        



Yosoro


Beautiful Cloud Drive Markdown NoteBook Desktop App




















## Download

The latest version of Yosoro for macOS, linux and Windows is available [here](https://github.com/IceEnd/Yosoro/releases):zap:.

**macOS 10.9+, Windows 7+ & Linux are supported.**

## Features

- Management notes
- Support **Latex** math formulas and draw diagrams.
- File synchronization(OneDrive is supported)
- Image upload (:white_check_mark: GitHub, :white_check_mark: Weibo, :white_check_mark: [SM.MS](https://sm.ms))
- Export notes as markdown or html or pdf
- Post article(Supports Medium)
- Beautiful theme

### ScreenShot

![](https://raw.githubusercontent.com/IceEnd/Yosoro-Img/img/yosoro/20190629193507-image.png)

## Theme

Mysterious Dark:crescent_moon: & Cute Light:high_brightness:

| Dark :crescent_moon:| Light :high_brightness: |
|:-------:|:-----:|
| ![](https://raw.githubusercontent.com/IceEnd/Yosoro-Img/img/yosoro/20190629190549-image.png) | ![](https://raw.githubusercontent.com/IceEnd/Yosoro-Img/img/yosoro/20190629190325-image.png) |

## Software Manuals

Please read the [wiki](https://github.com/IceEnd/Yosoro/wiki) for more content.

## Contributing Guide

### Install

```shell
yarn
```

The installation failed in `Windows`, can try this command:

```shell
yarn --ignore-platform
```

### Dev Tools Extension

```shell
cp ./config/devconfig.example.json ./config/devconfig.json
```

Edit `./config/devconfig.json`, add Chrome extensions, for example:

```json
{
"extensions": [
"/Users/xxx/Library/Application Support/Google/Chrome/Default/Extensions/lmhkpmbekcpmknklioeibfkpmmfibljd/2.15.3_0",
"/Users/xxx/Library/Application Support/Google/Chrome/Default/Extensions/fmkadmapgofadopljbjfkapdkoienihi/3.4.0_0"
]
}
```

### Run Main Process

```shell
npm run dev:main
```

### Run Renderer Process

```shell
npm run dev:renderer
```

### Build

```shell
npm run build:all|main|renderer
```

### Package

```
npm run packager:mac|win|win:64|linux
```

### Thanks

Thanks [muya](https://github.com/marktext/marktext), this is a great editor!

## Contributors

[![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors)

Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):

| [
Alchemy](https://www.coolecho.net)
[💻](https://github.com/IceEnd/Yosoro/commits?author=IceEnd "Code") [🎨](#design-IceEnd "Design") [📖](https://github.com/IceEnd/Yosoro/commits?author=IceEnd "Documentation") [⚠️](https://github.com/IceEnd/Yosoro/commits?author=IceEnd "Tests") | [
Jirawat Boonkumnerd](http://ntsd.github.io)
[💻](https://github.com/IceEnd/Yosoro/commits?author=ntsd "Code") | [
Xuehua Cai](http://www.pixcai.com)
[💻](https://github.com/IceEnd/Yosoro/commits?author=pixcai "Code") | [
Austin Leath](https://www.austinleath.com)
[📖](https://github.com/IceEnd/Yosoro/commits?author=AustinLeath "Documentation") | [
Hermes Gjini](http://afractal.me)
[📖](https://github.com/IceEnd/Yosoro/commits?author=afractal "Documentation") |
| :---: | :---: | :---: | :---: | :---: |

This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!

## License

GPL-3.0 © [Alchemy](./LICENSE)