[GH-ISSUE #1834] [FR] supports markdown code format #718

Closed
opened 2026-03-23 20:40:08 +00:00 by mirror · 21 comments
Owner

Originally created by @xiamaocheng on GitHub (Feb 10, 2023).
Original GitHub issue: https://github.com/AppFlowy-IO/AppFlowy/issues/1834

Originally assigned to: @gunjan-l on GitHub.

Description

supports markdown code format

Impact

coder

Additional Context

No response

Originally created by @xiamaocheng on GitHub (Feb 10, 2023). Original GitHub issue: https://github.com/AppFlowy-IO/AppFlowy/issues/1834 Originally assigned to: @gunjan-l on GitHub. ### Description supports markdown code format ### Impact coder ### Additional Context _No response_
Author
Owner

@annieappflowy commented on GitHub (Feb 10, 2023):

We need to create a documentation on the markdowns we support

<!-- gh-comment-id:1425227102 --> @annieappflowy commented on GitHub (Feb 10, 2023): We need to create a documentation on the markdowns we support
Author
Owner

@annieappflowy commented on GitHub (Feb 10, 2023):

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

  • Heading
  • bold text
  • italicized text
  • Ordered List
  • code
  • Strikethrough

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

Thanks!

<!-- gh-comment-id:1425323603 --> @annieappflowy commented on GitHub (Feb 10, 2023): Hi @xiamaocheng , Here is a list of markdowns we're supporting: - Heading - bold text - italicized text - Ordered List - code - Strikethrough Can you please let us know what other markdowns you need but we're not supporting? Thanks!
Author
Owner

@xiamaocheng commented on GitHub (Feb 10, 2023):

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

<!-- gh-comment-id:1425483248 --> @xiamaocheng commented on GitHub (Feb 10, 2023): 1.supports markdown export 2.provider features when writing code
Author
Owner

@AmanNegi commented on GitHub (Mar 2, 2023):

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. 😊

<!-- gh-comment-id:1451185895 --> @AmanNegi commented on GitHub (Mar 2, 2023): 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. 😊
Author
Owner

@annieappflowy commented on GitHub (Mar 2, 2023):

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

<!-- gh-comment-id:1451485461 --> @annieappflowy commented on GitHub (Mar 2, 2023): I suppose this is partially supported. @LucasXu0 can provide you with more details.
Author
Owner

@xiamaocheng commented on GitHub (Mar 2, 2023):

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: @.***>

<!-- gh-comment-id:1451581859 --> @xiamaocheng commented on GitHub (Mar 2, 2023): You're right. Do it. Good luck ------------------&nbsp;原始邮件&nbsp;------------------ 发件人: "Aman ***@***.***&gt;; 发送时间: 2023年3月2日(星期四) 上午10:37 收件人: ***@***.***&gt;; 抄送: ***@***.***&gt;; ***@***.***&gt;; 主题: 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: ***@***.***&gt;
Author
Owner

@LucasXu0 commented on GitHub (Mar 2, 2023):

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.

  • Heading
  • bold text
  • italicized text
  • Ordered List
  • Bulleted List
  • code
  • Strikethrough
  • underline
  • quote
Screenshot 2023-03-02 at 18 35 53
<!-- gh-comment-id:1451653280 --> @LucasXu0 commented on GitHub (Mar 2, 2023): 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. <img width="1531" alt="Screenshot 2023-03-02 at 18 30 47" src="https://user-images.githubusercontent.com/11863087/222403189-6bded089-0c0c-40dd-a96a-ecd68373a018.png"> It will be appreciated if you can complete the rest part. </br> > Supported Markdowns (i.e while writing in the document) For the second part, there are some markdown syntaxes have been implemented. * Heading * bold text * italicized text * Ordered List * Bulleted List * code * Strikethrough * underline * quote <img width="363" alt="Screenshot 2023-03-02 at 18 35 53" src="https://user-images.githubusercontent.com/11863087/222404434-84562bec-0f48-4be0-8e1d-204a5670294d.png">
Author
Owner

@AmanNegi commented on GitHub (Mar 9, 2023):

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. 😊

<!-- gh-comment-id:1461945514 --> @AmanNegi commented on GitHub (Mar 9, 2023): 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. 😊
Author
Owner

@gunjan-l commented on GitHub (Mar 15, 2023):

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!

<!-- gh-comment-id:1469474317 --> @gunjan-l commented on GitHub (Mar 15, 2023): 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!
Author
Owner

@LucasXu0 commented on GitHub (Mar 15, 2023):

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.

<!-- gh-comment-id:1469546803 --> @LucasXu0 commented on GitHub (Mar 15, 2023): 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`.
Author
Owner

@gunjan-l commented on GitHub (Mar 17, 2023):

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.

<!-- gh-comment-id:1473151261 --> @gunjan-l commented on GitHub (Mar 17, 2023): 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.
Author
Owner

@LucasXu0 commented on GitHub (Mar 17, 2023):

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

<!-- gh-comment-id:1473257251 --> @LucasXu0 commented on GitHub (Mar 17, 2023): @glunkad. Yes. You can add the new parsers in this directory. `AppFlowy/frontend/appflowy_flutter/lib/plugins/document/presentation/plugins/parsers`
Author
Owner

@gunjan-l commented on GitHub (Mar 18, 2023):

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

<!-- gh-comment-id:1474831344 --> @gunjan-l commented on GitHub (Mar 18, 2023): Hi @LucasXu0 , I tried to find the new parsers but I am not able to find could to suggest some.
Author
Owner

@LucasXu0 commented on GitHub (Mar 20, 2023):

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
<!-- gh-comment-id:1476239797 --> @LucasXu0 commented on GitHub (Mar 20, 2023): Hey, @glunkad. You can refer to this file. For example, you can implement a code block parser. <img width="828" alt="Screenshot 2023-03-20 at 21 30 56" src="https://user-images.githubusercontent.com/11863087/226354973-276afa22-910b-4eb7-858f-5d0689517ada.png">
Author
Owner

@gunjan-l commented on GitHub (Mar 27, 2023):

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

<!-- gh-comment-id:1485116667 --> @gunjan-l commented on GitHub (Mar 27, 2023): Hi @LucasXu0 , is there any other parser to be implemented?
Author
Owner

@LucasXu0 commented on GitHub (Mar 28, 2023):

@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.

<!-- gh-comment-id:1486379167 --> @LucasXu0 commented on GitHub (Mar 28, 2023): @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.
Author
Owner

@gunjan-l commented on GitHub (Apr 12, 2023):

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

<!-- gh-comment-id:1504608601 --> @gunjan-l commented on GitHub (Apr 12, 2023): Hi @LucasXu0, callout markdown is already present. Can you suggest other markdown ? I tried your work around you suggested but did not find anything.
Author
Owner

@LucasXu0 commented on GitHub (Apr 12, 2023):

@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.
<!-- gh-comment-id:1504617577 --> @LucasXu0 commented on GitHub (Apr 12, 2023): @glunkad I think you could optimize the underline logic, as shown in the screenshots below. Currently, we haven't implemented the parser for <u>...</u>. <img width="843" alt="Screenshot 2023-04-12 at 12 48 40" src="https://user-images.githubusercontent.com/11863087/231352824-e28df6c6-f000-4237-bab8-facf619bc116.png"> <img width="786" alt="Screenshot 2023-04-12 at 12 48 45" src="https://user-images.githubusercontent.com/11863087/231352846-37cfda7d-7686-4a3d-bef6-ae247c041944.png"> ## 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.
Author
Owner

@gunjan-l commented on GitHub (Apr 18, 2023):

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

<!-- gh-comment-id:1512490531 --> @gunjan-l commented on GitHub (Apr 18, 2023): Hey @LucasXu0 , can you please let me know in which file we are supposed to add it or create a new file.
Author
Owner

@xiamaocheng commented on GitHub (Jun 14, 2023):

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: @.***>

<!-- gh-comment-id:1591045989 --> @xiamaocheng commented on GitHub (Jun 14, 2023): Thank you very much for your hard work ------------------&nbsp;原始邮件&nbsp;------------------ 发件人: ***@***.***&gt;; 发送时间: 2023年6月13日(星期二) 下午3:58 收件人: ***@***.***&gt;; 抄送: ***@***.***&gt;; ***@***.***&gt;; 主题: 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: ***@***.***&gt;
Author
Owner

@dandv commented on GitHub (Dec 10, 2024):

Typing | at the beginning of a paragraph/block, should quote it. Any chance to implement this @LucasXu0 ?

<!-- gh-comment-id:2530078808 --> @dandv commented on GitHub (Dec 10, 2024): Typing `|` at the beginning of a paragraph/block, should quote it. Any chance to implement this @LucasXu0 ?
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
AppFlowy-IO/AppFlowy#718
No description provided.