milkdown / vscode Goto Github PK

View Code? Open in Web Editor NEW

256.0 256.0 10.0 2.99 MB

License: MIT License

JavaScript 4.45% TypeScript 78.42% CSS 17.13%

milkdown

vscode's Introduction

🍼 Milkdown

A plugin-driven WYSIWYG markdown Editor, inspired by Typora, built on top of prosemirror and remark.

The website is designed by Meo and Mirone. Powered by Theme Nord and Material Design.

Documentation

For more information, please check our official documentation website.

What's Next

You can check our Milkdown TODO project page to know what's on the plan.

You can also check milestones to know what's being worked on.

Community

Welcome to join our Discord community.

Contributing

Follow our contribution guide to learn how to contribute to milkdown.

Contributor

Special thanks to @Meo for her work in design.

Thanks

Thanks to the following projects and companies for their support to milkdown and the open source community.

License

MIT

vscode's People

Contributors

Stargazers

Watchers

Forkers

hereisfun datalayer-externals itsjohnward songdayi andrew6ix cvlvxi talesdv lkuoch jochenlinnemann zvm23

vscode's Issues

Mermaid support

Dear Saul-Mirone!
Thanks for the extension, I love it. The only thing I miss is the Mermaid support. I saw that milkdown has a plugin for mermaid. Could you add/enable it to this extension?

使用 Milkdown 打开包含某些内容的 Markdown 文件时出现错误

我发现将 Milkdown 设置为 VSCode 的默认 Markdown 浏览器之后，打开某些 .md 文件时是一片空白的。
我尝试逐一排查某个文档中的内容，最终发现这段会导 Mikdown 故障的文本

# BUG

```service
HI~
```

我又尝试了一些别的代码块，比如 vue，似乎任何不被支持的代码块格式都会像 service 一样导致 Milkdown 出现故障

Milkdown shortcuts conflict with built-in keybindings.

For example, Ctrl+B conflicts with "open sidebar":

Ctrl+Shift+B conflicts with "build task"

Maybe we can register keybinding commands to avoid that?

How do I change the font size? Make a little larger maybe?

The font seems to be very small compared to anything else on VsCode

Does not recognize line breaks

When opening a markdown file milkdown, it does NOT recognize link breaks. In fact, it seems like all line breaks are removed silently, only text are preserved.

Potential cause for #38

[Bug] Failed to parse code snippet

Describe the bug
A clear and concise description of what the bug is.

-   ```c
    int i;
    ```

This won't be parsed properly.

To Reproduce
Steps to reproduce the behavior:

make a markdown file with whatever name
copy the code above to the file
ctrl + p
"milkdown"
hit "enter"
get wrong rendering

Expected behavior
A clear and concise description of what you expected to happen.

parse the code snippet as a whole

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

OS: [e.g. iOS] Mac OS
Browser [e.g. chrome, safari] vscode
Version [e.g. 22] v0.0.12

Additional context
Add any other context about the problem here.

Make the VSCode description more descriptive

The current VSCode extension description is "Use milkdown in your favorite editor." compared to "Use Milkdown in your favorite editor to edit markdown.". I think this is a problem because it doesn't say that it edits Markdown files and that's going to be really confusing to people searching for a MD editor in the extension marketplace.

It's my recommendation that either the description be changed to match the repo description, or be changed to something else that makes it clear that Milkdown is for editing MD files.

Some other ideas:

Markdown with Milkdown
Edit Markdown with Milkdown
Milkdown Markdown Editor
Use Milkdown to edit Markdown

Bug: Mathematical formula input problem.

The characters cannot be entered consecutively when editing a formula block. The characters cannot be entered consecutively when editing a formula block. That is, the formula editing panel automatically exits with each character entered. In addition, the syntax for adding a label to a formula does not seem to be supported.

Enable editing of .md with "front matter"

Astro (https://astro.build/) is the new hotness in content-rich static site rendering - and they have a concept called "front matter" (https://docs.astro.build/en/guides/markdown-content/) which simply has a "---"-enclosed section at the very top:

---
some: yaml
content: here
---
We now get into markdown territory...

At the moment, milkdown-vscode will corrupt the front matter of any such .md file; the above content will be transformed into

***

some: yaml
content: here
-------------

We now get into markdown territory...

by a roundtrip through milkdown-vscode. It would be quite nice to be able to edit such .md files through milkdown, because Astro itself is all about working inside Visual Studio Code, creating content and implementing site functionality there.

What confuses me a bit is that milkdown suggests that it does gfm-formatted markup (https://github.github.com/gfm/#tables-extension-), and those Astro frontmatter-enriched .md render fine inside the Github renderer (see, for exmple, https://github.com/withastro/astro/blob/main/examples/with-markdown-plugins/src/pages/index.md)

So, in the end, this could possibly be made to work by adjusting the gfm plugin / enabling the gfm?

Perhaps a configuration option on milkdown-vscode along the lines of

Retain front matter in files (yes/no) - Some markdown files may contain a --- ... --- section at the very top - "front matter". If such front matter is present in a markdown file, retain this front matter section unchanged through edits.

Please support nested bullets

Can't figure out how to create this:

top level
- nested bullet

I have to do it manually.

Support custom components (mdx)

For md, Milkdown works well (except frontmatter became a title/big text). Bt for mdx, does not break, but shows custom components as a code blocks.

Can we have a config to auto import components based on a template, so when we use, vscode can show this components too?

local images load failed

For example

![](image/微生物学笔记/1641386328583.png)

![](image/微生物学笔记/1641386612027.png)

Above is grammar about local images in markdown. In marktext and vscode, load image success. However, it is fail to load images in milkdown.

VS Code

Milkdown

Cursor position lost and falls back to end of the document when saving

The cursor position is lost when saving using Ctrl+S. This causes the cursor to jump to its default position, which is end of the file, upon user input using keyboard.

It seems sometimes auto saving also causes this, but frankly speaking I cannot always reproduce it. So the cause is unknown to me.

Random spaces added in lists

Minimal reproduction

nC0vohz1.mp4

Simple video, you can add anything from my testing and it does this.

How can we configure milkdown?

Is there any way to configure the milkdown vscode extension?

Any plan to enable outline ?

Hi, this is a wonderful extension. Since outline is an import feature, any plan to enable outline ? Will this extension get an outline using VS Code's native struction or by itsself ?

[Bug] Slow & repetitive rerendering

Describe the bug
A clear and concise description of what the bug is.

slow: each time doing the rendering, it takes like one sec to render 800-line markdown
repetitive: when just switching tags without closing, it keeps rerendering every time the tag is active

To Reproduce
Steps to reproduce the behavior:

start a milkdown tag with 800 lines
start a new tag
switch to the new tag
switch back to the milkdown tag
experience the rerendering and the time it takes

Expected behavior
A clear and concise description of what you expected to happen.

fast: rendering take less time
render-once: don't do the rerendering just switching tag

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

OS: [e.g. iOS] Mac OS
Browser [e.g. chrome, safari] vscode
Version [e.g. 22] v0.0.12

Additional context
Add any other context about the problem here.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

npm

package.json

@babel/core ^7.18.10

@codemirror/commands ^6.2.3

@codemirror/lang-javascript ^6.1.8

@codemirror/language ^6.6.0

@codemirror/state ^6.2.0

@codemirror/view ^6.10.1

@lezer/highlight ^1.1.6

@lit-labs/context ^0.5.0

@milkdown/core ^7.2.3

@milkdown/ctx ^7.2.3

@milkdown/plugin-clipboard ^7.2.3

@milkdown/plugin-cursor ^7.2.3

@milkdown/plugin-emoji ^7.2.3

@milkdown/plugin-history ^7.2.3

@milkdown/plugin-indent ^7.2.3

@milkdown/plugin-listener ^7.2.3

@milkdown/plugin-math ^7.2.3

@milkdown/plugin-prism ^7.2.3

@milkdown/plugin-slash ^7.2.3

@milkdown/plugin-tooltip ^7.2.3

@milkdown/plugin-trailing ^7.2.3

@milkdown/plugin-upload ^7.2.3

@milkdown/preset-commonmark ^7.2.3

@milkdown/preset-gfm ^7.2.3

@milkdown/prose ^7.2.3

@milkdown/transformer ^7.2.3

@milkdown/utils ^7.2.3

@prosemirror-adapter/lit ^0.2.5

@tailwindcss/typography ^0.5.9

@types/glob ^8.0.0

@types/node 20.x

@types/vscode ^1.59.0

@typescript-eslint/eslint-plugin ^7.0.0

@typescript-eslint/parser ^7.0.0

autoprefixer ^10.4.14

clsx ^2.0.0

concurrently ^8.0.0

esbuild ^0.21.0

eslint ^9.0.0

eslint-config-prettier ^9.0.0

eslint-plugin-header ^3.1.1

eslint-plugin-import ^2.27.5

eslint-plugin-prettier ^5.0.0

eslint-plugin-simple-import-sort ^12.0.0

glob ^10.0.0

katex ^0.16.0

lit ^3.0.0

postcss ^8.4.23

postcss-cli ^11.0.0

postcss-import ^16.0.0

prettier ^3.0.0

prism-themes ^1.9.0

tailwindcss ^3.3.1

tippy.js ^6.3.7

ts-loader ^9.2.2

tsup ^8.0.0

typescript ^5.0.0

Check this box to trigger a request for Renovate to run again on this repository

Can you please add the math and table plug-ins

Thank you for the extension!
Can you please add the plug-ins for math and table to the extension?

[bug] crashes when reopen editor with unsaved file

Steps to reproduce:

Open a new file but don't save it
Type something
Right-click the tab of the file, choose "重新打开编辑器的方式" (Maybe "Reopen the editor with"? in the English version?)

The file crashes and the previous content is gone. Forever! :(

I can help to debug if someone gives me a hint on how to do this. No experience with VSCode extensions. Thanks!

Is it possible to trigger Snippets in milkdown editor?

Generally, you can insert snippets into markdown file in VS Code. However it seems snippets can not be triggered when using milkdown editor. Is it possible to insert snippets in milkdown editor? I think it's useful for math edit. 😃

Clicking on a title in the table of contents doesn't take me to that location

I don't know if this is a bug or simply a lack of implementation of this feature, but I think this feature is very important.

Request: tab and shift+tab adjust bullet/number list indentation

It would be convenient if while I am making a bulleted or numbered list to hit the tab or the shift+tab keys to adjust the indentation of the line item the cursors (or cursors) are currently on, including block highlighted lines.

File won't open properly

Thank you for this awesome project this is great :) I just have one issue where the following file will not open properly with milkdown.
https://github.com/L1lith/Sandhands/blob/master/README.md

Here's what it looks like to me in the editor:

Also I tried opening another file and it worked fine. I believe Milkdown for some reason doesn't like this file, it might be the HTML image tag in the beginning.

Some bugs need to be fixed.

The select box in the code box cannot be clicked if not set.
The cursor jump interval is too short, it is difficult to switch after a part is written.
Sometimes the cursor jumps suddenly when typing characters in a box.

Open a markdown file with Milkdown
After the file is opened, immediately click on close without making any changes.

Expected:
File closed successfully without any pop-up.

Actual:
Prompted with: Do you want to save the changes you made to xxxx.md?

Milkdown version: 0.0.15