Skip to content

Commit 1d4e59b

Browse files
committed
Merge branch 'dev'
Merge dev into main for Linux menu and Mermaid fixes
2 parents ad34733 + 8ab4f31 commit 1d4e59b

11 files changed

Lines changed: 919 additions & 74 deletions

File tree

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
name: Bug Report
2+
description: Report a bug in velotype
3+
title: "[Bug]: "
4+
labels: ["bug", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report a bug.
10+
11+
Before submitting, please search existing issues, test the latest release,
12+
and include the smallest reproduction you can provide.
13+
14+
- type: checkboxes
15+
id: checklist
16+
attributes:
17+
label: Checklist
18+
options:
19+
- label: I have searched the existing issues
20+
required: true
21+
- label: I have tested this on the latest release
22+
required: true
23+
24+
- type: input
25+
id: version
26+
attributes:
27+
label: velotype version
28+
description: Exact version number or commit hash.
29+
placeholder: e.g. 0.3.2
30+
validations:
31+
required: true
32+
33+
- type: dropdown
34+
id: platform
35+
attributes:
36+
label: Platform
37+
description: Where did the issue happen?
38+
options:
39+
- Windows
40+
- macOS
41+
- Linux(Ubuntu / Debian / Fedora / Arch / Kali, Wayland or X11)
42+
- Other(not currently supported)
43+
validations:
44+
required: true
45+
46+
- type: input
47+
id: environment
48+
attributes:
49+
label: Environment details
50+
description: Include OS version, Linux distro, desktop/session, scaling, display setup, IME, or other relevant context.
51+
placeholder: e.g. Ubuntu 24.04, GNOME, Wayland, X11, etc
52+
validations:
53+
required: true
54+
55+
- type: dropdown
56+
id: area
57+
attributes:
58+
label: Affected area
59+
description: Which part of velotype is affected?
60+
options:
61+
- Rendering / layout
62+
- Editing / IME / shortcuts
63+
- Markdown parsing
64+
- Menu / window / file operations
65+
- Export
66+
- Theme / i18n
67+
- Crash / freeze / performance
68+
- Other
69+
validations:
70+
required: true
71+
72+
- type: textarea
73+
id: actual
74+
attributes:
75+
label: What happened?
76+
description: Describe the actual behavior.
77+
placeholder: Tell us what you saw.
78+
validations:
79+
required: true
80+
81+
- type: textarea
82+
id: expected
83+
attributes:
84+
label: What did you expect to happen?
85+
description: Describe the expected behavior.
86+
placeholder: Tell us what should have happened.
87+
validations:
88+
required: true
89+
90+
- type: textarea
91+
id: reproduce
92+
attributes:
93+
label: Steps to reproduce
94+
description: Please provide the shortest possible steps.
95+
placeholder: |
96+
1. Open velotype
97+
2. Load a markdown file
98+
3. Click ...
99+
4. Observe ...
100+
validations:
101+
required: true
102+
103+
- type: textarea
104+
id: sample
105+
attributes:
106+
label: Minimal sample / reproduction file
107+
description: Paste a minimal markdown snippet, or link to a repo / gist / file if needed.
108+
placeholder: |
109+
```md
110+
# Minimal example
111+
...
112+
```
113+
validations:
114+
required: false
115+
116+
- type: textarea
117+
id: evidence
118+
attributes:
119+
label: Evidence / additional context
120+
description: Add logs, panic messages, screenshots, recordings, theme/font details, or anything else that may help.
121+
placeholder: |
122+
- Logs:
123+
- Screenshot:
124+
- Video:
125+
validations:
126+
required: false
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: Feature Request
2+
description: Suggest a new feature or improvement for velotype
3+
title: "[Feature]: "
4+
labels:
5+
- enhancement
6+
- needs-triage
7+
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
Thanks for suggesting a feature for velotype.
13+
14+
Before submitting, please search existing issues, keep the request focused,
15+
and describe the real workflow or use case behind it.
16+
17+
If an existing feature is behaving incorrectly, please use the Bug Report template instead.
18+
19+
- type: checkboxes
20+
id: checklist
21+
attributes:
22+
label: Checklist
23+
options:
24+
- label: I have searched the existing issues
25+
required: true
26+
- label: This request is focused on a single feature or improvement
27+
required: true
28+
29+
- type: textarea
30+
id: problem
31+
attributes:
32+
label: Problem / use case
33+
description: Describe the limitation, missing workflow, or goal this request addresses.
34+
placeholder: |
35+
Example:
36+
Editing large markdown documents currently becomes difficult because...
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
id: solution
42+
attributes:
43+
label: Proposed solution
44+
description: Describe how you would like Velotype to behave.
45+
placeholder: |
46+
Example:
47+
Add a floating outline panel that...
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
id: additional_context
53+
attributes:
54+
label: Additional context
55+
description: Add references, mockups, related tools, links, or sample Markdown if useful.
56+
placeholder: |
57+
Example:
58+
Related tools, mockups, workflow notes, or Markdown examples...
59+
validations:
60+
required: false

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "velotype"
3-
version = "0.3.4"
3+
version = "0.3.9"
44
edition = "2024"
55
license = "Apache-2.0"
66

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
![Velotype banner](./assets/icon/velotype-banner.png)
66

7-
**A Rust + GPUI native Markdown editor with WYSIWYG and source editing modes.**
7+
**A Rust + GPUI native Markdown editor with WYSIWYG and source editing modes.**
88

99
[Editor Showcase](./assets/showcase/showcase.md)
1010

@@ -43,6 +43,8 @@ Velotype targets Windows, Linux, and macOS. The app is naturally suitable for di
4343

4444
Download the Windows, Linux, or macOS build from the [Velotype Releases](https://github.com/manyougz/velotype/releases) page. Release artifacts are designed as portable desktop programs and can be run directly.
4545

46+
> Note: macOS users need to sign the `app` file locally on their machine; otherwise, Velotype will not run properly.
47+
4648
### 2. Build from source
4749

4850
Prerequisites:
@@ -72,6 +74,8 @@ Syntax support will continue to improve. Planned work includes:
7274

7375
- [x] ~~Mind-map drawing and rendering support~~
7476
- [x] ~~LaTeX math syntax and rendering support~~
77+
- [ ] Optimize the parsing and rendering capabilities for extremely large Markdown documents
78+
- [ ] Workspace Mode and Outline Parsing
7579
- [ ] Built-in image hosting
7680
- [ ] More complete IME behavior
7781

@@ -88,7 +92,7 @@ Start with the example files:
8892

8993
In the app, use `Theme -> Add Theme Config` or `Language -> Add Language Config` to import a `.json` or `.jsonc` file. JSONC comments are accepted for writing and sharing examples; normalized configuration files saved by the app are strict JSON.
9094

91-
> Thank you for helping translate Velotype or enrich the Velotype theme ecosystem.
95+
> Thank you for helping translate Velotype or enrich the Velotype theme ecosystem. The project is evolving rapidly, so theme field changes may occur frequently.
9296
9397
## Architecture
9498

assets/README.zh-CN.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ Velotype 目标支持 Windows、Linux 和 macOS。应用天然适合作为独立
4343

4444
[Velotype Releases](https://github.com/manyougz/velotype/releases) 页面下载 Windows、Linux 或 macOS 构建。Release 产物按便携桌面程序设计,可直接运行。
4545

46+
> 注意,macOS 系统用户需要在本地自行对 `app` 文件进行签名,否则 Velotype 无法正常运行。
47+
4648
### 2. 从源码构建
4749

4850
前置需求:
@@ -72,6 +74,8 @@ Velotype 目前已经支持几乎所有基础 Markdown 语法,以及绝大多
7274

7375
- [x] ~~脑图绘图与渲染支持~~
7476
- [x] ~~LaTeX 数学语法与渲染支持~~
77+
- [ ] 优化对超大 Markdown 文档的解析与渲染能力
78+
- [ ] 工作区模式与大纲解析
7579
- [ ] 内置图床
7680
- [ ] 更完善的 IME 功能
7781

@@ -88,7 +92,7 @@ Velotype 将视觉主题和界面语言包拆分管理。主题文件可以覆
8892

8993
在应用内使用 `主题 -> 添加主题配置``语言 -> 添加语言配置` 导入 `.json` / `.jsonc` 文件。JSONC 注释用于方便编写和分享示例;应用规范化保存后的配置文件会是严格 JSON。
9094

91-
> 十分感谢您帮助翻译 Velotype 或丰富 Velotype 主题生态!
95+
> 十分感谢您帮助翻译 Velotype 或丰富 Velotype 主题生态!项目处于快速更迭阶段,主题字段的变更可能较为频繁。
9296
9397
## 架构
9498

0 commit comments

Comments
 (0)