# electron-note

**Repository Path**: baiyang-lzy/electron-note

## Basic Information

- **Project Name**: electron-note
- **Description**: markdown编辑器
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 4
- **Forks**: 0
- **Created**: 2021-02-07
- **Last Updated**: 2024-05-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# electron-note

使用 Electron 技术开发的 Markdown 编辑器。

## Screenshots
![](./screenshot.png)

## Supported Platforms

Windows、macOS、Linux

## How to use

在 Gitee Releases 页面下载适合你的平台的安装包/二进制文件。

## How to develop

- 首先安装 Node.js 环境
- 然后将本仓库源码 Clone 到本地，然后

```
npm install
npm start
```
- 如果遇到了electron failed to install correctly的问题，手动执行

```
node ./node_modules/electron/install.js
```
## How to package

根据目标平台的不同，有如下打包命令可选：
```
npm run package_windows
npm run package_linux
npm run package_darwin
npm run package_mas
```

## Features

- Markdown 编辑器
- 丰富的配色方案

## Todo

- 笔记本功能
- Markdown 语法高亮
- 支持 Latex
- 插件系统

## Known Bugs

- 基于比例的同步滚动并不精准，在一定情况下可能影响使用
- 未对编辑区进行安全审计，若Markdown文件中含有JavaScript恶意代码，有可能在预览区生效，并调用Node.js模块
- 可能不支持在macOS平台上的文件关联功能


## License
本软件是自由软件；您可以在自由软件基金会发布的 GPL v3 许可证下重新发布或修改它；

发布本软件的目的是希望它能够在一定程度上帮到您。但我们并不为它提供任何形式的担保，也无法保证它可以在特定用途中得到您希望的结果。


## Third Party Legal Notices
This product use Third Party code for certain functions may include licensed under
terms that require this product to display the following notices:

* jQuery v3.4.0 | (c) JS Foundation and other contributors | jquery.org/license
* github-markdown-css | (c) https://github.com/sindresorhus | licensed under MIT
* marked.js | (c) Christopher Jeffrey | MIT licensed | https://github.com/markedjs/marked
* Bootstrap v4.6.0 | (c) The Bootstrap Authors | (c) Twitter, Inc. | licensed on MIT
* Sizzle.js | (c)JS Foundation and other contributors, https://js.foundation/ | https://github.com/jquery/sizzle/blob/master/LICENSE.txt
* jQuery JavaScript Library v3.5.1 | https://jquery.com/ | jquery.org/license
* Font Awesome | https://fontawesome.com/license/free