# Yosoro

**Repository Path**: Truman129/Yosoro

## Basic Information

- **Project Name**: Yosoro
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-02-06
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center">
  <img src="./app/views/assets/images/logo.png" width="200"/>
  <h3 align="center">Yosoro</h3>
  <p align="center">Beautiful Cloud Drive Markdown NoteBook Desktop App</p>
  <p align="center">
    <img src="https://img.shields.io/badge/platform-masOS%20%7C%20Linux%20%7C%20Windows-lightgrey.svg?style=flat-square" />
  </p>
  <p align="center">
    <a target="__blank" href="https://github.com/IceEnd/Yosoro/releases">
      <img src="https://img.shields.io/github/release/iceend/yosoro.svg?style=flat-square" />
    </a>
    <a target="__blank" href="https://travis-ci.org/IceEnd/Yosoro">
      <img src="https://img.shields.io/travis/IceEnd/Yosoro.svg?style=flat-square">
    </a>
    <a target="__blank" href="https://github.com/IceEnd/Yosoro/blob/master/LICENSE">
      <img src="https://img.shields.io/github/license/IceEnd/Yosoro.svg?style=flat-square" />
    </a>
  </p>
  <p align="center">
    <a target="__blank" href="https://github.com/IceEnd/Yosoro/releases">
      <img src="https://img.shields.io/github/downloads/IceEnd/Yosoro/total.svg?style=flat-square">
    </a>
  </p>
</p>

## 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

<p align="center">Mysterious Dark:crescent_moon: & Cute Light:high_brightness:</p>

| 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)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore -->
| [<img src="https://avatars1.githubusercontent.com/u/11556339?v=4" width="100px;"/><br /><sub><b>Alchemy</b></sub>](https://www.coolecho.net)<br />[💻](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") | [<img src="https://avatars3.githubusercontent.com/u/8283616?v=4" width="100px;"/><br /><sub><b>Jirawat Boonkumnerd</b></sub>](http://ntsd.github.io)<br />[💻](https://github.com/IceEnd/Yosoro/commits?author=ntsd "Code") | [<img src="https://avatars2.githubusercontent.com/u/11440779?v=4" width="100px;"/><br /><sub><b>Xuehua Cai</b></sub>](http://www.pixcai.com)<br />[💻](https://github.com/IceEnd/Yosoro/commits?author=pixcai "Code") | [<img src="https://avatars2.githubusercontent.com/u/32113014?v=4" width="100px;"/><br /><sub><b>Austin Leath</b></sub>](https://www.austinleath.com)<br />[📖](https://github.com/IceEnd/Yosoro/commits?author=AustinLeath "Documentation") | [<img src="https://avatars0.githubusercontent.com/u/8417583?v=4" width="100px;"/><br /><sub><b>Hermes Gjini</b></sub>](http://afractal.me)<br />[📖](https://github.com/IceEnd/Yosoro/commits?author=afractal "Documentation") |
| :---: | :---: | :---: | :---: | :---: |
<!-- ALL-CONTRIBUTORS-LIST:END -->

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

## License

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