AppFlowy-IO / AppFlowy

Bring projects, wikis, and teams together with AI. AppFlowy is an AI collaborative workspace where you achieve more without losing control of your data. The best open source alternative to Notion.
https://www.appflowy.io
GNU Affero General Public License v3.0
55.78k stars 3.63k forks source link

[FR] supports markdown code format #1834

Closed xiamaocheng closed 1 year ago

xiamaocheng commented 1 year ago

Description

supports markdown code format

Impact

coder

Additional Context

No response

annieappflowy commented 1 year ago

We need to create a documentation on the markdowns we support

annieappflowy commented 1 year ago

Hi @xiamaocheng , Here is a list of markdowns we're supporting:

Can you please let us know what other markdowns you need but we're not supporting?

Thanks!

xiamaocheng commented 1 year ago

1.supports markdown export 2.provider features when writing code

AmanNegi commented 1 year ago

Hey there, I would love to work on this task! From my understanding we want to add the following to the documentation:

Correct me if I am wrong, also please let me know in which file we are supposed to add it. 😊

annieappflowy commented 1 year ago

I suppose this is partially supported. @LucasXu0 can provide you with more details.

xiamaocheng commented 1 year ago

You're right. Do it. Good luck

------------------ 原始邮件 ------------------ 发件人: "Aman @.>; 发送时间: 2023年3月2日(星期四) 上午10:37 收件人: @.>; 抄送: @.>; @.>; 主题: Re: [AppFlowy-IO/AppFlowy] [FR] supports markdown code format (Issue #1834)

Hey there, I would love to work on this task! From my understanding we want to add the following to the documentation:

Supported Export Types

Supported Markdowns (i.e while writing in the document)

Correct me if I am wrong, also please let me know in which file we are supposed to add it. 😊

— Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you were mentioned.Message ID: @.***>

LucasXu0 commented 1 year ago

Hey, @AmanNegi.

Supported Export Types

For the first part, we have supported exporting our document to markdown text. However, some styles may not be supported yet.

Screenshot 2023-03-02 at 18 30 47

It will be appreciated if you can complete the rest part.


Supported Markdowns (i.e while writing in the document)

For the second part, there are some markdown syntaxes have been implemented.

Screenshot 2023-03-02 at 18 35 53
AmanNegi commented 1 year ago

Sorry forgot this gonna complete this really fast.

Just wanted to know this:

please let me know in which file we are supposed to add it. 😊

glunkad commented 1 year ago

Hi @xiamaocheng @LucasXu0 @annieappflowy , I was wondering if anyone could update me on the status of Github issue . Has it been resolved yet? If not, I would like to offer my assistance in resolving the issue. Would it be okay if I try to tackle the problem and submit a pull request with a proposed solution? Thank you!

LucasXu0 commented 1 year ago

Hey, @glunkad @AmanNegi . It hasn't been solved yet. For now, some styles will miss while exporting document to markdown, like divider, code block. You can refer to this function documentToMarkdown.

glunkad commented 1 year ago

Hi @LucasXu0 , I completed setting up the project and got it running . Correct me I am wrong ,from my understanding we need to add all the supported markdown code format to documentation and also refer documentToMarkdown function from file plugins/document/application/share_bloc.dart also please let me know in which file we are supposed to add it.

LucasXu0 commented 1 year ago

@glunkad. Yes. You can add the new parsers in this directory. AppFlowy/frontend/appflowy_flutter/lib/plugins/document/presentation/plugins/parsers

glunkad commented 1 year ago

Hi @LucasXu0 , I tried to find the new parsers but I am not able to find could to suggest some.

LucasXu0 commented 1 year ago

Hey, @glunkad. You can refer to this file. For example, you can implement a code block parser.

Screenshot 2023-03-20 at 21 30 56
glunkad commented 1 year ago

Hi @LucasXu0 , is there any other parser to be implemented?

LucasXu0 commented 1 year ago

@glunkad Sure. For example, callout, and some built-in markdown syntaxes. You can import a markdown file to AppFlowy, and then export it via the share button, and check the diff between them.

glunkad commented 1 year ago

Hi @LucasXu0, callout markdown is already present. Can you suggest other markdown ? I tried your work around you suggested but did not find anything.

LucasXu0 commented 1 year ago

@glunkad I think you could optimize the underline logic, as shown in the screenshots below. Currently, we haven't implemented the parser for ....

Screenshot 2023-04-12 at 12 48 40 Screenshot 2023-04-12 at 12 48 45

How to reproduce

  1. Click the share button and export the Markdown file for the Read Me document.
  2. Click the + button and import the exported Markdown file.
glunkad commented 1 year ago

Hey @LucasXu0 , can you please let me know in which file we are supposed to add it or create a new file.

xiamaocheng commented 1 year ago

Thank you very much for your hard work

------------------ 原始邮件 ------------------ 发件人: @.>; 发送时间: 2023年6月13日(星期二) 下午3:58 收件人: @.>; 抄送: @.>; @.>; 主题: Re: [AppFlowy-IO/AppFlowy] [FR] supports markdown code format (Issue #1834)

Closed #1834 as completed.

— Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you were mentioned.Message ID: @.***>