Giter Club home page Giter Club logo

website's Introduction

🍼  Milkdown

ci ts download-badge version discord-badge commit license

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

contributors

Special thanks to @Meo for her work in design.

Sponsors

If you like this project, please consider fund me to help the maintenance.

Thanks

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

           

License

MIT

website's People

Contributors

eereeska avatar eyadfareh avatar lzy1960 avatar masonbrothers avatar novout avatar rbeier avatar samrobbins85 avatar saul-mirone avatar sjdeak avatar smartich0ke avatar sqooid avatar syntaxbullet avatar tbdsux avatar tesse0ract avatar tsukinose81 avatar windid avatar yanquanfahei avatar zhenlychen avatar zxh3 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

website's Issues

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
  • @milkdown/core 7.0.0-next.1
  • @milkdown/ctx 7.0.0-next.1
  • @milkdown/preset-commonmark 7.0.0-next.1
  • @milkdown/prose 7.0.0-next.1
  • @milkdown/transformer 7.0.0-next.1
  • @next/font 13.1.6
  • @types/node 18.13.0
  • @types/react 18.0.28
  • @types/react-dom 18.0.10
  • eslint 8.34.0
  • eslint-config-next 13.1.6
  • next 13.1.6
  • react 18.2.0
  • react-dom 18.2.0
  • typescript 4.9.5
  • copy-webpack-plugin ^11.0.0

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

Problems with Editing Headings

When I type # with a space before H2, it doesn’t switch to H1; instead, it switches to H3.
In ProseMirror and most markdown editors, this operation should switch to the H1 style.
I'm worried that my description may be difficult to understand, so I've attached a reference video demo the operation.

Thank you to the author for maintaining this project, it has been very helpful to me. If there is a donation channel available, I would be very happy to contribute what little I can.

2023-04-01-2.mov

[Bug] shift-up arrow doesn't select multiple list items

Initial checklist

  • I agree to follow the code of conduct
  • I searched issues and discussions and couldn’t find anything (or linked relevant results below)

Affected packages and versions

7.3.5

Link to runnable example

No response

Steps to reproduce

Go to https://milkdown.dev/playground

Scroll to the list and click after the second item (Designer: Mirone)

Press shift-up arrow repeatedly

Expected behavior

It will select other items in the list

Actual behavior

It only selects the current item

Runtime

Chrome

OS

macOS

Build and bundle tools

No response

[Bug] Checkbox cannot be switched in Mozilla Firefox

Initial checklist

  • I agree to follow the code of conduct
  • I searched issues and discussions and couldn’t find anything (or linked relevant results below)

Affected packages and versions

latest

Link to runnable example

https://milkdown.dev/playground

Steps to reproduce

  1. Install Mozilla Firefox.
  2. Open milkdown playground.
  3. Click the checkboxes.

图片

Expected behavior

Checkbox should switch between checked and unchecked.

Actual behavior

Nothing happened. Google Chrome and Microsoft Edge are not affected by this bug, they can act as expected. I have not tested Safari.

Vditor has the same bug. Since it does not use prosemirror, it seems that it is not (or not only) prosemirror's bug.

Runtime

Firefox

OS

Linux

Build and bundle tools

No response

[Bug] Switching between light mode and dark mode in playground overwrites source markdown

Initial checklist

  • I agree to follow the code of conduct
  • I searched issues and discussions and couldn’t find anything (or linked relevant results below)

Affected packages and versions

Milkdown Playgroundv7.3.0

Link to runnable example

No response

Steps to reproduce

Type anything into the editor, switch between light modes, and the source text will be reset to default text.

Expected behavior

You keep your text (sorry for lame response, but I feel like this is a given)

Actual behavior

The preview will not be effected, but the source text will be reset to the default text.

Runtime

Chrome

OS

Linux

Build and bundle tools

No response

[Bug] Block tooltip by website appears in the wrong position when hovering inside a table

Initial checklist

  • I agree to follow the code of conduct
  • I searched issues and discussions and couldn’t find anything (or linked relevant results below)

Affected packages and versions

Latest

Link to runnable example

No response

Steps to reproduce

This is reproducible in the live demo milkdown.dev, just hover your cursor on the first row.

Expected behavior

The block tooltip should appear for the first row.

Actual behavior

The block tooltip appears for the second row. I'm not sure whether this is a bug specific in milkdown website or caused by plugin-block.

Runtime

Firefox

OS

Windows

Build and bundle tools

Other (please specify in steps to reproduce)

Documentation Version

I have a suggestion about documentation website.

We should also see documentation for older versions too. Because currently I'm using the 6.3 version for milkdown and current milkdown documentation website only supports 7.0. Thus, I'm not able to find the documentation that I'm looking for.

[Bug] Checkbox is not clickable in Firefox

Initial checklist

  • I agree to follow the code of conduct
  • I searched issues and discussions and couldn’t find anything (or linked relevant results below)

Affected packages and versions

milkdown/@latest

Link to runnable example

No response

Steps to reproduce

  1. Please visit https://milkdown.dev/playground using Latest Firefox version 120.01 on macOS
  2. Try click checkbox in demo editor, unable to uncheck any of them.

In our project, we also implement custom component for markdown tasklist using MUI's Checkbox component, met same issue as official demo.

Expected behavior

Please see above

Actual behavior

Please see above

Runtime

No response

OS

No response

Build and bundle tools

No response

[Bug] ImageTooltip in the playground doesn't update the DOM

Initial checklist

  • I agree to follow the code of conduct
  • I searched issues and discussions and couldn’t find anything (or linked relevant results below)

Affected packages and versions

Milkdown Playground v.7.2.3

Link to runnable example

https://milkdown.dev/playground

Steps to reproduce

First, thank you for creating such an amazing editor framework! I'm a sponsor 🙂

Visit the Milkdown Playground. Click the image and edit any attribute. Close the tooltip.

Expected behavior

Edited attributes should update the editor state and DOM.

Actual behavior

No changes are made. Also, sometimes the values in the popover disappear.

I really want this to work because I want to use tooltip plugins to allow users to edit links and images!

Runtime

Chrome

OS

macOS

Build and bundle tools

No response

[Bug] Inserting emoji from emoji menu using enter key does not delete search text in list nodes

Initial checklist

  • I agree to follow the code of conduct
  • I searched issues and discussions and couldn’t find anything (or linked relevant results below)

Affected packages and versions

7.3.5

Link to runnable example

https://stackblitz.com/edit/github-xjl3gc?file=components%2FEditor.tsx

Steps to reproduce

  • Create a ordered or unordered list in the editor.
  • Trigger the emoji menu using the : syntax.
  • Press enter to select an emoji.

Expected behavior

Emoji is inserted and the search syntax that was typed, eg. :b is deleted.

Actual behavior

Emoji is inserted but search syntax is not deleted, eg. :be 🐻 . However, if I click on the selected emoji instead of using the enter key, it is inserted without issue. This occurs on both the instance I have running on electron with react and webpack and the linked online example.

Runtime

Firefox, Electron

OS

Windows, macOS

Build and bundle tools

Webpack, Vite

[Bug]selection with multiple lines convert to not multiple but one list item by bullet/ordered-list menu button

Initial checklist

  • I agree to follow the code of conduct
  • I searched issues and discussions and couldn’t find anything (or linked relevant results below)

Affected packages and versions

@milkdown/preset-commonmark

Link to runnable example

No response

Steps to reproduce

https://milkdown.dev/playground

why not using wrapInList instead of wrapIn in @milkdown/preset-commonmark

import { wrapInList } from "@milkdown/prose/schema-list";
{
commands: (nodeType) => [
      createCmd(WrapInBulletList, () => wrapInList(nodeType)),
]
}

Expected behavior

image

Actual behavior

image

Runtime

Chrome

OS

macOS

Build and bundle tools

No response

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.