Use Markdowneditor in more places #27772

JakobDev · 2023-10-24T14:08:47Z

Inspired by #27759

There are places in Gitea which support rendering markdown, but instead of the Markdowneditor the normal Editor is used. This PR fixes this.

It includes the following things:

Project description
User description
Org description

Please tell me, if I missed something.

Screenshots

templates/repo/issue/fields/textarea.tmpl

templates/shared/combomarkdowneditor.tmpl

web_src/js/features/misc.js

templates/shared/combomarkdowneditor.tmpl

web_src/js/features/comp/ComboMarkdownEditor.js

templates/projects/new.tmpl

routers/web/repo/projects.go

templates/shared/combomarkdowneditor.tmpl

…ggestions

JakobDev · 2023-10-25T07:04:53Z

While working on this I found out, that the Markdown in Projects descriptions on the User/Org level is not rendered. I fixed this.

delvh

Apart from below LGTM

templates/shared/combomarkdowneditor.tmpl

GiteaBot · 2024-04-09T07:29:06Z

@JakobDev please fix the merge conflicts. 🍵

routers/web/org/projects.go

lunny

I don't think this is necessary. Since user/org supports .profile, we don't need to support markdown on their descriptions. And for project description, they will be displayed on the list of projects, I think formating with markdown on a project list page will disturb many people.

delvh · 2024-04-10T06:52:22Z

@lunny these places already support Markdown, only their editor indicates otherwise as far as I understood

delvh · 2024-06-21T21:47:40Z

@lunny so, what do we do about this PR?

wxiaoguang · 2024-06-22T01:44:34Z

Actually usually I also tried to help & push some PRs to move on. The problem is that many PRs are inactive and not that responsive, for example, 25049 since Jun, 2023. (not a native speaker, I would like to mean "have responses after getting review comments" by responsive).

So usually I would like to spend time on PRs that are more active.

ps: there are still some problems in this PR I guess .......

Update: I merged main into this PR and resolved the conflicts. But there are still some problems in code, I am not sure whether the author is still interested in this PR.

delvh · 2024-06-22T09:04:04Z

But there are still some problems in code

Could you give an example what we need to fix?

wxiaoguang · 2024-06-22T09:15:44Z

routers/web/repo/projects.go

@@ -137,6 +137,10 @@ func RenderNewProject(ctx *context.Context) {
 	ctx.Data["CardTypes"] = project_model.GetCardConfig()
 	ctx.Data["CanWriteProjects"] = ctx.Repo.Permission.CanWrite(unit.TypeProjects)
 	ctx.Data["CancelLink"] = ctx.Repo.Repository.Link() + "/projects"
+	ctx.Data["ProjectMarkdownPreviewURL"] = fmt.Sprintf("%s/markup", ctx.Repo.Repository.Link())
+	ctx.Data["ProjectMarkdownPreviewContext"] = ctx.Repo.Repository.Link()
+	ctx.Data["ProjectMarkdownPreviewMode"] = "comment"


Here and other places: the mode shouldn't be "comment" because the description is rendered in original markdown format

wxiaoguang · 2024-06-22T09:16:39Z

routers/web/web.go

@@ -974,6 +974,8 @@ func registerRoutes(m *web.Router) {
 	// end "/repo": create, migrate, search

 	m.Group("/{username}/-", func() {
+		m.Post("/markup", web.Bind(structs.MarkupOption{}), misc.Markup)


It should be placed under /-/markup because it doesn't really belong to "user"

wxiaoguang · 2024-06-22T09:17:11Z

web_src/js/features/misc.js

+
+  if (markdownEditor.length > 0) {
+    initComboMarkdownEditor(markdownEditor[0]);
+  }


If there are more than one editors, only the first one gets initialized.

wxiaoguang · 2024-06-22T09:18:34Z

But there are still some problems in code

Could you give an example what we need to fix?

Added some quick reviews (haven't reviewed it carefully yet, maybe I could checkout and edit directly if this PR gets enough interests).

Use Markdowneditor on more places in Gitea

861521a

GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Oct 24, 2023

pull-request-size bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Oct 24, 2023

github-actions bot added modifies/translation modifies/frontend labels Oct 24, 2023

delvh reviewed Oct 24, 2023

View reviewed changes

templates/repo/issue/fields/textarea.tmpl Outdated Show resolved Hide resolved

templates/shared/combomarkdowneditor.tmpl Outdated Show resolved Hide resolved

web_src/js/features/misc.js Show resolved Hide resolved

templates/shared/combomarkdowneditor.tmpl Outdated Show resolved Hide resolved

silverwind reviewed Oct 24, 2023

View reviewed changes

web_src/js/features/comp/ComboMarkdownEditor.js Outdated Show resolved Hide resolved

silverwind reviewed Oct 24, 2023

View reviewed changes

templates/projects/new.tmpl Outdated Show resolved Hide resolved

wxiaoguang reviewed Oct 25, 2023

View reviewed changes

routers/web/repo/projects.go Show resolved Hide resolved

wxiaoguang reviewed Oct 25, 2023

View reviewed changes

templates/shared/combomarkdowneditor.tmpl Outdated Show resolved Hide resolved

Render Markdown in Projects on user level, remove dead code, apply su…

8c91542

…ggestions

pull-request-size bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Oct 25, 2023

Add missing class

96b51f9

Remove preview mode from options

8d46cab

delvh added type/enhancement An improvement of existing functionality topic/ui Change the appearance of the Gitea UI labels Nov 8, 2023

delvh changed the title ~~Use Markdowneditor on more places in Gitea~~ Use Markdowneditor in more places Nov 10, 2023

delvh approved these changes Nov 10, 2023

View reviewed changes

templates/shared/combomarkdowneditor.tmpl Outdated Show resolved Hide resolved

GiteaBot added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Nov 10, 2023

JakobDev added 3 commits January 15, 2024 10:47

Merge branch 'main' into moremarkdown

df33aab

Improve documentation and fix build

c9c7d3e

Merge branch 'main' into moremarkdown

c7ad7c5

silverwind removed the modifies/frontend label Mar 31, 2024

techknowlogick approved these changes Apr 3, 2024

View reviewed changes

GiteaBot added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Apr 3, 2024

delvh added the reviewed/wait-merge This pull request is part of the merge queue. It will be merged soon. label Apr 9, 2024

GiteaBot removed the reviewed/wait-merge This pull request is part of the merge queue. It will be merged soon. label Apr 9, 2024

Merge branch 'main' into moremarkdown

5f754d4

github-actions bot added modifies/go Pull requests that update Go code modifies/templates This PR modifies the template files modifies/js labels Apr 9, 2024

lunny reviewed Apr 9, 2024

View reviewed changes

routers/web/org/projects.go Outdated Show resolved Hide resolved

lunny requested changes Apr 9, 2024

View reviewed changes

GiteaBot added lgtm/blocked A maintainer has reservations with the PR and thus it cannot be merged and removed lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. labels Apr 9, 2024

Merge branch 'main' into moremarkdown

abf3141

pull-request-size bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jun 22, 2024

wxiaoguang marked this pull request as draft June 22, 2024 02:02

wxiaoguang reviewed Jun 22, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use Markdowneditor in more places #27772

Use Markdowneditor in more places #27772

JakobDev commented Oct 24, 2023

JakobDev commented Oct 25, 2023

delvh left a comment

GiteaBot commented Apr 9, 2024

lunny left a comment

delvh commented Apr 10, 2024

delvh commented Jun 21, 2024

wxiaoguang commented Jun 22, 2024 •

edited

Loading

delvh commented Jun 22, 2024

wxiaoguang Jun 22, 2024

wxiaoguang Jun 22, 2024

wxiaoguang Jun 22, 2024

wxiaoguang commented Jun 22, 2024

Use Markdowneditor in more places #27772

Are you sure you want to change the base?

Use Markdowneditor in more places #27772

Conversation

JakobDev commented Oct 24, 2023

JakobDev commented Oct 25, 2023

delvh left a comment

Choose a reason for hiding this comment

GiteaBot commented Apr 9, 2024

lunny left a comment

Choose a reason for hiding this comment

delvh commented Apr 10, 2024

delvh commented Jun 21, 2024

wxiaoguang commented Jun 22, 2024 • edited Loading

delvh commented Jun 22, 2024

wxiaoguang Jun 22, 2024

Choose a reason for hiding this comment

wxiaoguang Jun 22, 2024

Choose a reason for hiding this comment

wxiaoguang Jun 22, 2024

Choose a reason for hiding this comment

wxiaoguang commented Jun 22, 2024

wxiaoguang commented Jun 22, 2024 •

edited

Loading