Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FR] A markup language for appflowy #7032

Open
arromattic opened this issue Dec 22, 2024 · 4 comments
Open

[FR] A markup language for appflowy #7032

arromattic opened this issue Dec 22, 2024 · 4 comments
Assignees
Labels
export features related to exporting data from AppFlowy

Comments

@arromattic
Copy link

arromattic commented Dec 22, 2024

Description

Currently appflowy has two export option markdown and html .
Markdown has no widely accepted standard example .
Appflowy also has features that like gallery that none of the flavor's of markdown cover . Exporting as regular markdown is destructive . And for html it's not convenient either .

Suggestion 1 : Allow to export as Wikitext/mediawiki markup

https://en.wikipedia.org/wiki/Help:Wikitext

Wikitext has way more formatting than markdown and can allow users to move or edit their note content in other apps and even in wikipedia (mediawiki)

Suggestion 2 : A custom markup language for appflowy

If it is not possible to implement export/import as wikitext a modified markdown can be created for appflowy .

Impact

  1. Users can export data without losing formatting and blocks like Gallery , Image size , custom table width etc
  2. Easy to import/export data
  3. Easy to convert into other file formats using pandoc

Additional Context

Pandoc support if custom markup is implemented.

@LucasXu0 LucasXu0 changed the title [FR] A markup language for appflowey [FR] A markup language for appflowy Dec 23, 2024
@LucasXu0
Copy link
Collaborator

@arromattic We have a JSON export mode in the experimental env, which include all document formats, such as image galleries, table widths, and more.

Here’s a sample. Does it meet your expectations?
Simple_Table_V2.1.json

@LucasXu0 LucasXu0 self-assigned this Dec 23, 2024
@LucasXu0 LucasXu0 added the export features related to exporting data from AppFlowy label Dec 24, 2024
@casainho
Copy link

Please no Markdown!! I came from Joplin that is good app, although Markdown makes is a junk, like tables are really basic and I think is due to limitations on Markdown.

@arromattic
Copy link
Author

The json format is a significant improvement over plain markdown . But is rather difficult for average user to read/edit manually like wikitext . Are all the syntaxes will be specified ? like color , mathblock , italic etc . If yes i think that's most likely enough for now as users don't have to worry about missing formattings when exporting/importing .

I do think a new file format should be created and the syntaxes should be specified instead of generic json so users can easily identify it and easily convert into other format using a script or pandoc (assuming someone adds it).

  1. Is it possible to import the json to appflowy ?
  2. Does the json export only covers table like how notion has separate file for table and markdown for notes or includes everything in a page ?

@arromattic
Copy link
Author

Please no Markdown!! I came from Joplin that is good app, although Markdown makes is a junk, like tables are really basic and I think is due to limitations on Markdown.

I am also a user of joplin and joplins markdown export is what made me create this issue .

In joplin there are a few markdown export problems :

  1. You can adjust image size on the note but on export markdown doesn't support image size
  2. You can download various plug-ins to extend the markdown but once you export , you have no idea of what you used to use .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
export features related to exporting data from AppFlowy
Projects
None yet
Development

No branches or pull requests

3 participants