1943time / bluestone

A WYSIWYG Markdown editor, improve reading and editing experience. and generate your Markdown files into online documents in the easiest and fastest way.

Inkdown

Improve markdown reading and editing experience, and facilitate network sharing.

Documentation | 中文文档

mac-arm64 mac-x64	win-arm64 win-x64	linux-amd64.deb | linux-x86_64.AppImage linux-arm64.AppImage | linux-arm64.deb	deploy deploy-cn

OR

The release time of mac store will be delayed by 1-3 days

由于工信部要求APP备案原因，**内地地区暂未上架Mac Store。

---

Introduction

Inkdown (bluestone) is a Markdown reading, editing, and sharing tool. Almost fully compatible with the GitHub Flavored Markdown standard, while extending the Mermaid graphics and Katex formula, supporting light and dark styles, and somewhat different from other WYSIWYG editors, Inkdown does not pursue complete customization. Its core goal is comfortable reading, smooth editing of Markdown, and document sharing in the simplest way possible.

As a document publisher, markdown source code mode is undoubtedly efficient and free, but as a note, it is not conducive to reading. The table element of markdown is not conducive to writing, and the double-column mode is not conducive to focusing, so the Inkdown Editor was developed. It combines rich text with markdown editing habits to help you record daily, and saves it in standard markdown format, which allows your notes to be used anywhere and backed up in any way.

dv1.mp4

Features

• The rich text editing mode is used, while also compatible with Markdown syntax conversion and editing habits. When using the search function, Markdown symbols will not be searched.
• Automatically record and clear file history, can be viewed and rolled back at any time.
• Using shiki as a code shader to make code highlights more fine-grained and aesthetically pleasing.
• Provides a powerful sharing program, Linux server required doc.
• Enhanced table operations, allowing for easy adjustment of the order and quantity of rows and columns in the table, and the ability to wrap within the table.
• Support the editing and display of block and inline Katex formulas
• Supports mermaid graphic syntax.
• The file path link can be automatically reconstructed, and when a file or folder is renamed or moved, the local path of the links or images that the document depends on will be automatically changed.
• You can freely drag and adjust the order of document elements.
• Supports multi tab editing mode
• Support pasting HTML, plain text, and markdown code. When pasting HTML and markdown code, it can be configured to automatically download network images to the local machine and convert paths during pasting.

bluestone's Issues

Create horizontal separation line with `---`

Currently, entering --- will create a front matter, even if it was entered in the middle of a document. I wish that if this was entered in the middle of the document, it will create a separation line instead (which is the behavior in Obsidian, Typora, and GitHub).

Todo checkboxes not vertically aligned

I think the checkboxes in a todo list should be vertically aligned, but they are not.

Request for Copy-Paste or Duplicate Functionality

Thank you for developing this fantastic markdown editor. I really appreciate your work.

I would like to request a feature for copying or duplicating files. There could be various methods to achieve this, such as allowing users to copy-paste files or adding a 'Duplicate' button upon right-clicking a file.

Currently, copying the source code of a markdown file is possible, but it introduces unwanted blank spaces. Moreover, the process involves multiple steps. Having a dedicated copy-paste or duplicate functionality would greatly enhance the user experience.

I'm curious to know if there are any plans to implement such a feature in future updates. Thank you!

Typing link problem

There is a widely way to typing link []() then fill the word. But it does't work in this app.

Is there any way to solve this?

切换焦点后不能恢复到原输入位置，而是跳到文档第一行

环境：macos 14.2.1
版本：App Store 安装版
描述：不管是全屏状态还是非全屏状态，当将焦点切换到其他 App 再返回时，很大几率会导致输入焦点会跳到文档第一行

体验优化

体验了两天，发现了几个基础性 bug，希望作者能修复一下。环境是 macOS 14.2.1，bluestone 版本 1.5.2。

• 标题快捷键偶尔不可用，无法触发
• 从其它应用切回软件的时候，文档就从上次编辑或查看位置滚动到开头，经常发生，体验很差
• 渲染不及时，像一些加粗、数学公式等并不是立即渲染，不知道什么时候才会渲染

period in the folder name

When I add a period in the folder name, the part after the period can't been seen.

For example
Original folder name: 9Apple
After adding a period between 9 and A, the folder will become only "9".

支持页面内跳转功能

感谢作者大大，非常好用的markdown记录软件！

有个小请求，希望可以支持页面内跳转功能。比如[跳转至二级标题](##二级标题)。

说说未来打算？永久开源？还是分版本经营？

Task List line breaks bug

There is a little bug when formatting task lists. When I put line breaks between the items, they are somehow not saved. When I close and reopen the application the line breaks are reset.

Line Breaks formatting

No line breaks anymore when reopening the application

how to build the web server

i want to use it with online how to build it? very thanks

Option to change the default letter style in math

Most Latex renderers use italic font by default, but Bluestone currently uses non-italic, as shown below.

I hope that there is an option to change the default font so that the render result is consistent with other renderers.

[Suggestion] 还是关于ArchLinux打包运行问题

如题。
根据ArchLinux的nodejs/electron相关打包准则，尽量分离electron，因为ArchLinux AUR已经有打包好的各个版本的Electron，同时Extra之类的仓库中也会包含主流的Electron版本。
我在尝试调用系统自带的electron22运行app.asar文件后，软件可以打开，但是点击任何菜单都无法使用。
具体命令如下：

env PATH="./:$PATH" ELECTRON_IS_DEV=0 NODE_ENV=production electron22 app.asar

终端运行结果：

libpng warning: iCCP: known incorrect sRGB profile

不知道是否还需要添加什么别的启动参数？

Writing inline math directly

It seems that the only possible way to write an inline math in the current version is to enter $ $, however, I believe many people would prefer typing the math content before the second $ sign. Would you consider adding this feature? If not, why?

Pressing `shift + tab` in a list

When pressing shift + tab in a list, the desired behavior is usually to move the current list item leftwards (reducing its indentation depth), but the current behavior (in MacOS) is that the item is moved rightwards. Pressing shift + tab again causes a "indent character" to be entered, while the expected behavior is, again, to move the current item leftwards.

当文件保存在 OneDrive 同步目录中，保留列表，但不输人内容，切换焦点时，会导致输入焦点跳转到第一行

如题
同一个文件，如果在本地，是不会发生的
但是，如果这个文件保存在 OneDrive 的同步目录中，不管是带序号的列表还是不带序号的列表，大概率出触发这个现象：
保留一个列表内容为空（从上一个列表回车换行）时，不输入任何内容
切换到其他 APP 或者将焦点转到其他窗口，再返回此文件的编辑界面
大概率会发生跳转
测试文档见附件
测试文档.md
问题避免方法：每次从其他 APP 复制了内容后，在本文档换行粘贴，不保留空白列表项，即可避免
严重性不大，估计排错很麻烦

[issue]设置中去掉大纲勾选，再次打开后勾选还在

如题

can not use alt/option to select words

can not use alt/option to select words

会提供 markdown 源码编辑器支持么？

希望能像 Typora 那样通过 Command + / 切换源码模式，因为有时候源码模式操作的效率更高

<ruby><rt></rt></ruby> support

is it possibel to support this format? <ruby><rt></rt></ruby>
I have many notes in Japanese with this format.
I will really really appreiate your effort if the Bluestone can support this format.

文档内添加表格会白屏

系统：win10 IoT
版本：19045.3803
现象：打开的文档内，点击添加表格按钮会出现白屏问题，关闭程序后重新打开文档，发现表格已经添加

In MacOS, command + W does not close the last tab

In MacOS, command + W can close a tab, but when there is only one document open, nothing happens. In most editors, such as Obsidian and Typora, this hotkey closes the application, which is the feature that I request.

Documentation/guide for contribution?

Hi, I love this application and would like to contribute. Is there any guide for doing so? (e.g, the CONTRIBUTING.md file in other repos)

location problem after link

default.mp4

English.mp4

As shown, typing after link will be wrong.

space.mp4

Then I found that there is a unvisible space after link.

How can we avoid this?

Automatically identify and convert "full-width" versions of Markdown syntax

When editing a Chinese document, it can be tedious to change between full-width and half-width (全角 and 半角) characters for using Markdown syntax, and I wish that the editor could automatically identify the full-width versions of Markdown syntax and convert them into half-width versions. E.g., when entering ￥￥ and a next line, the editor should convert it into $$ and start a math block. The same applies to ···{language} -> ```{language}.

支持调整行高大小

行高 Line Height 的调整
就是这个

非常感谢您的付出，软件使用起来体验很好，作为一个本地的markdown编辑器很不错。请问有计划支持更多的编辑器外观自定义选项吗吗？对我来说，文字比较密集的情境下的行高有点少，所以如果可以支持自定义调整行高就更好了！
感谢！

### can't be parsed.

When there is nothing followed by ###, bluestone can't ignore this what it can't parse and give a full white screen.

Create any md file. Type only ###. Bluestone will be confused.

recent 3 used file on the top tab.

currently, I can't find a easy way to switch two or three open md files.
Is it possible the recent 3 open files can be shown on the top tab?
And users are allowed to change 3 to 4 or 5 in the settings.

the outline doesn't include heading 1

is it normal that the outline only show heading 2 (## sub topic) can it include heading 1 (# topic1)?

Inability to Use Command-W on Mac

While using your application, I've noticed that the Command-W shortcut becomes unresponsive, even when the application is running in the background. For instance, I'm unable to close tabs in Chrome or exit VSCode.

I'm using an M2 MacBook Air, and the Bluestone version is 1.4.9.

Is there any chance that something in Bluestone is blocking the Command-W functionality?

"source" mode

Is there a "source" mode as in Typora such that we can directly edit the source text instead of the rendered one?

Command Palette

Is it possible to add a command palette such as in Obsidian and VS Code (cmd + shift + P)? It is much more convenient than navigating through the settings or remembering all hotkeys.

Untitled files

In many editors, we can input content in "Untitled files" by pressing mod + N. Can we do that in Bluestone?

a bookmark view or a tag view

is it possible to have feature like bookmark?
Even I know "open quickly" is there, bookmark can provide a different experience to access the frequency files.

is it possibel to add tag to md files?
The benefit is to provide a different view to group or classify tons of md files.

"move to trash" doesn't work.

After picking a md file, I chosed "move to trash" and then the program crashed.
I started the program again. But the md file I wanted to remov is still there.

建议支持键盘 shift + 方向键 选择多个或多行文本内容

如题
目前版本只能使用鼠标来选择多个或多行内容

Scrollbar background is white in dark mode in MacOS

In MacOS, when using dark mode, the background of the scrollbar is white, but I believe it should be the same as the document background. As shown below.

Bullet points in front of TODO items

Currently, a TODO item has a bullet point to the left, as shown below.

I think this should be hidden, which is the norm in most Markdown renderers such as GitHub, as shown below.

• test.

Some advice on enhancement in KaTeX display and HTML elements

This project is quite outstanding. It might be one of the best Markdown editors I have ever seen.

However, while using it for a while, I found a few issues with it, which I wish could be fixed.

This is a sample document:

# Inputing formula in MS Word

If you have installed MS Word, you can input formula in MS Word following the steps below:

As an example you may input the following formula in MS Word:

$$\int_{-\infty}^{+\infty} e^{-x^2} dx = \sqrt{\pi}$$

- Open MS Word
- copy the code below

    ```Tex
    \int_{-\infty}^{+\infty} e^{-x^2} dx = \sqrt{\pi}
    ```

- Paste the code in MS Word
- Select the code
- Press <kbd>Alt</kbd> + <kbd>=</kbd> on your keyboard

You will see the formula code is converted to a formula $\int_{-\infty}^{+\infty} e^{-x^2} dx = \sqrt{\pi}$

This is what I expect to be displayed ( Screenshot from Visual Studio Code):

This is what displayed in this editor

Anyway, this is quite an excellent program. Just wish it could be better. Thanks!

Option + arrow keys does not work inside code blocks in MacOS

In MacOS, when the caret is in a code block, pressing Option + arrow keys only moves one character at a time, while the default behavior in most editors is to move one word at a time.

自动保存

你好，我暂时没有发现自动保存功能。
我觉得自动保存将会是一个不错的功能，防止编写内容的丢失

2 bugs and 2 feature

bug:

1. when I open the line number in code block, the Front matter will be hided
   
2. the code in line will wrap
   

feature

1. wish the image url input field can be always be the longest state
2. wish users can choose wether the default local image url is relative path or absolute path

无法用命令行打开markdown文件

打开后还是初始页面，而不是指定的markdown文件内容

Small UX improvements

I really like the app, great work!!

There are only two things that sometimes interrupt my workflow:

1. No drag and drop dupport when dragging in files from the finder into an folder inside Bluestone

I often find myself dragging in images, pdfs, videos or other files next to the markdown files. Unfortunately directly dragging from Finder or Downloads Stack into the bluestone folder view is not supported. It would be great to add that functionality!
(For images I know that I can directly drop them into the markdown files, but as I am working with a lot of subdirectories I prefer them to be in the specific subdirectory of the note and not all in one global folder. Maybe it would also be cool to add the option to set an relative path as image storage folder in settings like for example "./images", that is then always relative to the note file)

2. No keyboard shortcut for deleting files in the folder view.
It would be great to add the keyboard shortcut Cmd + Backspace on Mac (maybe Delete on Windows) for deleting files or folders. Ideally with a little keyboard navigable warning popup similar to the one in VSCode.

Mac OS Ventura 13.6, Bluestone Version 0.12.7

[Bugs] 在ArchLinux下编译出错

如题。0.7.0版本。
执行完pnpm install之后，执行pnpm build，报错信息如下：

Could not resolve "../share/User" from "src/renderer/src/components/Nav.tsx"
file: /home/zxp-endeavouros/.cache/paru/clone/bluestone/src/bluestone-0.7.0/src/renderer/src/components/Nav.tsx
error during preview electron app:
RollupError: Could not resolve "../share/User" from "src/renderer/src/components/Nav.tsx"
    at error (file:///home/zxp-endeavouros/.cache/paru/clone/bluestone/src/bluestone-0.7.0/node_modules/.pnpm/[email protected]/node_modules/rollup/dist/es/shared/node-entry.js:2245:30)
    at ModuleLoader.handleInvalidResolvedId (file:///home/zxp-endeavouros/.cache/paru/clone/bluestone/src/bluestone-0.7.0/node_modules/.pnpm/[email protected]/node_modules/rollup/dist/es/shared/node-entry.js:24632:24)
    at file:///home/zxp-endeavouros/.cache/paru/clone/bluestone/src/bluestone-0.7.0/node_modules/.pnpm/[email protected]/node_modules/rollup/dist/es/shared/node-entry.js:24594:26
 ELIFECYCLE  Command failed with exit code 1.

看了下源代码，在bluestone-0.7.0/src/renderer/src/components/Nav.tsx中有三行：

import {Login} from '../share/Login'
import {User} from '../share/User'
import {Share} from '../share/Share'

而在share目录中，确实是没有任何文件。

自定义markdown渲染规则

很优秀的作品，感谢！
可以自定义markdown渲染的规则吗？比如设定 ::: warning 被渲染为警示条。
我的具体需求是，在bluestone 中markdown，然后发布到vitepress网站上（我想这种需求还是比较普遍）。但现在缺少一些vitepress专属的渲染规则，导致在bluestone中无法预览最终效果（如下图）。最理想的情况是我们提供常用SSG的渲染选项，勾选就可以切换，这样使用不同SSG的用户都可以预览自己最终的网页效果。
或者提供指导，我们可以自己fork，然后加自己的效果，甚至也可以贡献。

Resizable table of content

Can we resize the table of contents panel on the right?

Caret position after the closing `$` in inline math

I wish that after enter the closing $, the caret position should be placed after this character, but currently the caret is positioned before the closing $.

Opening this file type is not currently supported while open an html file

Sometimes, I save some HTML files.
When I use Bluestone to open the HTML files, it tells me [ Opening this file type is not currently supported while open a html file ]
Because this function mediaType does not handle HTML files.

I processed it, and everything is fine now.

So, Do you think it's necessary to handle this?

Tooltip for hotkeys

When hovering some button that has a corresponding hotkey, I would like the hotkey to be shown with a tooltip because I often forget the hotkey. For instance, in the popup menu below:

I wish there were a popup tooltip that shows the corresponding hotkey above my cursor when I hover over each of these buttons.