# ONote - Markdown 本地笔记应用

**Repository Path**: doublecc/ONote

## Basic Information

- **Project Name**: ONote - Markdown 本地笔记应用
- **Description**: 基于 electron 和 monaco-editor 构建的 Markdown 编辑器(笔记应用)。支持多种数据源、双向编辑等特性，支持插件。
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2024-09-03
- **Last Updated**: 2024-09-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ONote 
![ONote](./docs/assets/screenshot.gif)

## 主要特性
- 支持标准"Markdown"和Github风格语法
- 支持实时预览，双向同步滚动
- 支持ToC（Table of Contents）、Emoji表情、Task lists等扩展语法
- 支持TeX科学公式（基于KaTeX）、PlantUML、Mermaid Diagram;
- 支持插件扩展，当前包括图片标注、Drawio等插件
- 支持独立窗口预览，充分利用多屏，一屏编辑、一屏预览
- 支持Markdown模板，按模板创建新文件
- 支持多数据源，当前支持本地目录和SSH目录


## 下载

[Release](https://github.com/pansinm/ONote/releases)

## Development

```bash
npm install turbo --global
yarn dev
```

## Compile

### 编译前准备

#### Fedora
```bash
sudo dnf install libxcrypt-compat
sudo dnf install rpm-build
```

### 编译
```bash
yarn compile
```

## 依赖于

1. 脚手架 [vite-electron-builder](https://github.com/cawa-93/vite-electron-builder)
2. 编辑器 [monaco-editor](https://microsoft.github.io/monaco-editor/)
3. [Markdown AST](https://github.com/syntax-tree/mdast)
4. Graphviz 渲染 [@hpcc-js/wasm](https://github.com/hpcc-systems/hpcc-js-wasm)

## License

[MIT](LICENSE)