The Unified and Autonomous Development Platform
feat: Able to display markdown file TOC at right side
Robin Shen58b26ebac9f2
diff --git a/server-core/src/main/java/io/onedev/server/web/component/markdown/MarkdownBlobViewer.java b/server-core/src/main/java/io/onedev/server/web/component/markdown/MarkdownBlobViewer.javanew file mode 100644index 0000000000..f28c3a3e45--- /dev/null+++ b/server-core/src/main/java/io/onedev/server/web/component/markdown/MarkdownBlobViewer.java@@ -0,0 +1,16 @@+package io.onedev.server.web.component.markdown;++import org.apache.wicket.model.IModel;+import org.jspecify.annotations.Nullable;++/**+ * A markdown viewer whose content comes from a repository blob.+ */+public class MarkdownBlobViewer extends MarkdownViewer {++ public MarkdownBlobViewer(String id, IModel<String> model,+ @Nullable ContentVersionSupport contentVersionSupport) {+ super(id, model, contentVersionSupport);+ }++}diff --git a/server-core/src/main/java/io/onedev/server/web/component/markdown/MarkdownOutlineDropdownLink.java b/server-core/src/main/java/io/onedev/server/web/component/markdown/MarkdownOutlineDropdownLink.javanew file mode 100644index 0000000000..7364e17067--- /dev/null+++ b/server-core/src/main/java/io/onedev/server/web/component/markdown/MarkdownOutlineDropdownLink.java@@ -0,0 +1,30 @@+package io.onedev.server.web.component.markdown;++import org.apache.wicket.Component;+import org.jspecify.annotations.Nullable;++import io.onedev.server.web.component.floating.AlignPlacement;+import io.onedev.server.web.component.floating.FloatingPanel;+import io.onedev.server.web.component.link.DropdownLink;++public abstract class MarkdownOutlineDropdownLink extends DropdownLink {++ public MarkdownOutlineDropdownLink(String id) {+ super(id, AlignPlacement.bottom(0), false, true);+ }++ @Nullable+ protected abstract MarkdownBlobViewer getViewer();++ @Override+ protected Component newContent(String id, FloatingPanel dropdown) {+ return new MarkdownOutlinePanel(id, getViewer(), false).setTrigger(this);+ }++ @Override+ protected void onConfigure() {+ super.onConfigure();+ setVisible(getViewer() != null);+ }++}diff --git a/server-core/src/main/java/io/onedev/server/web/component/markdown/MarkdownOutlinePanel.html b/server-core/src/main/java/io/onedev/server/web/component/markdown/MarkdownOutlinePanel.htmlnew file mode 100644index 0000000000..05324ec7fe--- /dev/null+++ b/server-core/src/main/java/io/onedev/server/web/component/markdown/MarkdownOutlinePanel.html@@ -0,0 +1,4 @@+<wicket:panel>+ <div wicket:id="resizeHandle" class="ui-resizable-handle ui-resizable-w flex-shrink-0"></div>+ <div class="content flex-grow-1 overflow-auto"></div>+</wicket:panel>diff --git a/server-core/src/main/java/io/onedev/server/web/component/markdown/MarkdownOutlinePanel.java b/server-core/src/main/java/io/onedev/server/web/component/markdown/MarkdownOutlinePanel.javanew file mode 100644index 0000000000..4389b4acf0--- /dev/null+++ b/server-core/src/main/java/io/onedev/server/web/component/markdown/MarkdownOutlinePanel.java@@ -0,0 +1,54 @@+package io.onedev.server.web.component.markdown;++import org.apache.wicket.Component;+import org.apache.wicket.behavior.AttributeAppender;+import org.apache.wicket.markup.head.IHeaderResponse;+import org.apache.wicket.markup.head.JavaScriptHeaderItem;+import org.apache.wicket.markup.head.OnDomReadyHeaderItem;+import org.apache.wicket.markup.html.WebMarkupContainer;+import org.apache.wicket.markup.html.panel.Panel;+import org.unbescape.javascript.JavaScriptEscape;++public class MarkdownOutlinePanel extends Panel {++ private final Component viewer;++ private final boolean sidebar;++ private Component trigger;++ public MarkdownOutlinePanel(String id, Component viewer, boolean sidebar) {+ super(id);+ this.viewer = viewer;+ this.sidebar = sidebar;+ }++ public MarkdownOutlinePanel setTrigger(Component trigger) {+ this.trigger = trigger;+ return this;+ }++ @Override+ protected void onInitialize() {+ super.onInitialize();++ add(new WebMarkupContainer("resizeHandle").setVisible(sidebar));+ add(AttributeAppender.append("class", "markdown-outline overflow-hidden "+ + (sidebar ? "side" : "dropdown")));+ setOutputMarkupId(true);+ }++ @Override+ public void renderHead(IHeaderResponse response) {+ super.renderHead(response);++ response.render(JavaScriptHeaderItem.forReference(new MarkdownResourceReference()));+ String triggerId = trigger != null+ ? "'" + JavaScriptEscape.escapeJavaScript(trigger.getMarkupId(true)) + "'"+ : "undefined";+ String script = String.format("onedev.server.markdown.initOutline('%s', '%s', %s, %s);",+ getMarkupId(), viewer.getMarkupId(true), sidebar, triggerId);+ response.render(OnDomReadyHeaderItem.forScript(script));+ }++}diff --git a/server-core/src/main/java/io/onedev/server/web/component/markdown/markdown.css b/server-core/src/main/java/io/onedev/server/web/component/markdown/markdown.cssindex ce9290010b..fabdd52a70 100644--- a/server-core/src/main/java/io/onedev/server/web/component/markdown/markdown.css+++ b/server-core/src/main/java/io/onedev/server/web/component/markdown/markdown.css@@ -456,6 +456,57 @@ body.markdown-editor-expanded {color: var(--dark-mode-light-gray);}+.markdown-outline {+ display: flex;+}+.markdown-outline.side {+ border-left: 1px solid var(--light-gray);+ background: white;+ flex-shrink: 0;+}+.dark-mode .markdown-outline.side {+ border-left-color: var(--dark-mode-lighter-dark);+ background: var(--dark-mode-dark);+}+.markdown-outline.side>.ui-resizable-handle {+ border-left: 1px solid var(--light-gray);+ background: var(--light) url(/~icon/grip3.svg) no-repeat scroll center center;+ background-size: 18px 18px;+ cursor: w-resize;+ width: 4px;+ position: relative;+ left: 0;+}+.dark-mode .markdown-outline.side>.ui-resizable-handle {+ border-left-color: var(--dark-mode-lighter-dark);+ background-color: var(--dark-mode-light-dark);+ background-image: url(/~icon/dark-grip3.svg);+}+.markdown-outline>.content {+ padding: 0.6rem;+ overflow-x: hidden !important;+}+.markdown-outline>.content>.item {+ padding-top: 0.35rem;+ padding-right: 0.6rem;+ padding-bottom: 0.35rem;+ border-radius: 0.42rem;+ color: var(--gray-dark);+}+.dark-mode .markdown-outline>.content>.item {+ color: var(--dark-mode-gray);+}+.markdown-outline>.content>.item:hover,+.markdown-outline>.content>.item.active {+ background: var(--light);+ color: var(--primary);+}+.dark-mode .markdown-outline>.content>.item:hover,+.dark-mode .markdown-outline>.content>.item.active {+ background: var(--dark-mode-light-dark);+ color: var(--primary);+}+#reference-tooltip {z-index: 1000;background-color: var(--light-info);diff --git a/server-core/src/main/java/io/onedev/server/web/component/markdown/markdown.js b/server-core/src/main/java/io/onedev/server/web/component/markdown/markdown.jsindex e56b0f936b..5414103308 100644--- a/server-core/src/main/java/io/onedev/server/web/component/markdown/markdown.js+++ b/server-core/src/main/java/io/onedev/server/web/component/markdown/markdown.js@@ -1385,6 +1385,64 @@ onedev.server.markdown = {});}},+ initOutline: function(outlineId, viewerId, sidebar, triggerId) {+ var $outline = $("#" + outlineId);+ var $viewer = $("#" + viewerId);+ var $content = $outline.children(".content");+ var $headings = $viewer.find(".markdown-rendered").first()+ .find("h1, h2, h3, h4, h5, h6").filter(function() {+ return $(this).children("a.header-anchor").length != 0;+ });++ $content.empty();+ $headings.each(function() {+ var $heading = $(this);+ var href = $heading.children("a.header-anchor").first().attr("href");+ var label = $heading.clone().children("a.header-link, a.header-anchor").remove().end().text().trim();+ var level = parseInt(this.tagName.substring(1));+ var $link = $("<a class='item d-block text-truncate'></a>")+ .attr("href", href)+ .attr("title", label)+ .css("padding-left", ((level - 1) * 1.2 + 0.6) + "rem")+ .text(label);+ $link.on("click", function() {+ $content.children("a").removeClass("active");+ $(this).addClass("active");+ });+ $content.append($link);+ });++ if (triggerId) {+ var $trigger = $("#" + triggerId);+ if ($trigger.is(":checkbox"))+ $trigger = $trigger.closest("label");+ $trigger.toggle($headings.length != 0);+ }+ if ($headings.length == 0)+ $outline.hide();++ if (sidebar && $headings.length != 0 && !$outline.hasClass("ui-resizable")) {+ var $viewerContainer = $viewer;+ $outline.resizable({+ autoHide: false,+ handles: {"w": $outline.children(".ui-resizable-handle")},+ minWidth: 160,+ resize: function(e, ui) {+ if ($viewerContainer.outerWidth() < 300)+ $(this).resizable({maxWidth: ui.size.width});+ },+ stop: function(e, ui) {+ $(this).resizable({maxWidth: undefined});+ Cookies.set("markdownBlob.outline.width", ui.size.width, {expires: Infinity});+ }+ });+ }+ },+ toggleOutline: function(outlineId, visible) {+ $("#" + outlineId).toggle(visible);+ Cookies.set("markdownBlob.outline", visible ? "yes" : "no", {expires: Infinity});+ $(window).resize();+ },onViewerDomReady: function(containerId, taskCallback, taskSourcePositionDataAttribute, referenceCallback,suggestionCallback, translations) {onedev.server.markdown.translations = translations;diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/folder/FolderViewPanel.html b/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/folder/FolderViewPanel.htmlindex 98500f3418..8610894f3c 100644--- a/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/folder/FolderViewPanel.html+++ b/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/folder/FolderViewPanel.html@@ -16,12 +16,13 @@</tr></table><div wicket:id="readme" class="readme">- <div class="head">+ <div class="head d-flex align-items-center"><b wicket:id="title" class="title mr-2"></b>- <a wicket:id="edit"><wicket:svg href="edit" class="icon"></wicket:svg></a>+ <a wicket:id="outline" class="ml-auto" t:data-tippy-content="Outline"><wicket:svg href="unordered-list" class="icon"></wicket:svg></a>+ <a wicket:id="edit" t:data-tippy-content="Edit" class="ml-2"><wicket:svg href="edit" class="icon"></wicket:svg></a></div><div wicket:id="body" class="body p-4"></div></div></div><div wicket:id="userCard" class="user-card-content"></div>-</wicket:panel>\ No newline at end of file+</wicket:panel>diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/folder/FolderViewPanel.java b/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/folder/FolderViewPanel.javaindex b5e2d7ce95..15872e1ba0 100644--- a/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/folder/FolderViewPanel.java+++ b/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/folder/FolderViewPanel.java@@ -45,7 +45,8 @@ import io.onedev.server.web.behavior.AbstractPostAjaxBehavior;import io.onedev.server.web.behavior.CtrlAwareOnClickAjaxBehavior;import io.onedev.server.web.component.blob.BlobIcon;import io.onedev.server.web.component.link.ViewStateAwareAjaxLink;-import io.onedev.server.web.component.markdown.MarkdownViewer;+import io.onedev.server.web.component.markdown.MarkdownBlobViewer;+import io.onedev.server.web.component.markdown.MarkdownOutlineDropdownLink;import io.onedev.server.web.component.user.card.PersonCardPanel;import io.onedev.server.web.page.project.blob.ProjectBlobPage;import io.onedev.server.web.page.project.blob.render.BlobRenderContext;@@ -252,7 +253,7 @@ public class FolderViewPanel extends Panel {}});- readmeContainer.add(new MarkdownViewer("body", new LoadableDetachableModel<String>() {+ var markdown = new MarkdownBlobViewer("body", new LoadableDetachableModel<String>() {@Overrideprotected String load() {@@ -271,6 +272,15 @@ public class FolderViewPanel extends Panel {return context;}+ };+ readmeContainer.add(markdown);+ readmeContainer.add(new MarkdownOutlineDropdownLink("outline") {++ @Override+ protected MarkdownBlobViewer getViewer() {+ return markdown;+ }+});add(readmeContainer);diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/folder/folder-view.css b/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/folder/folder-view.cssindex c7a17b2962..fe41b90158 100644--- a/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/folder/folder-view.css+++ b/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/folder/folder-view.css@@ -15,11 +15,17 @@border-top: none;}.folder-view>.readme>.head {+ position: sticky;+ top: 0;+ z-index: 10;padding: 0.5rem 1rem;background: var(--light);border-top: 1px solid var(--light-gray);border-bottom: 1px solid var(--light-gray);}+.folder-view>.readme .header-anchor {+ scroll-margin-top: 48px;+}.folder-view>.readme>.body {max-width: 900px;margin-left: auto;diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/renderers/markdown/MarkdownBlobViewPanel.html b/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/renderers/markdown/MarkdownBlobViewPanel.htmlindex c9d8ad5d9e..06bb58319d 100644--- a/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/renderers/markdown/MarkdownBlobViewPanel.html+++ b/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/renderers/markdown/MarkdownBlobViewPanel.html@@ -1,3 +1,9 @@<wicket:extend>- <div wicket:id="markdown"></div>-</wicket:extend>\ No newline at end of file+ <div class="markdown-blob-view flex-grow-1 d-flex overflow-hidden">+ <div wicket:id="markdown" class="markdown-content flex-grow-1 overflow-auto"></div>+ <div wicket:id="outline" class="need-width"></div>+ </div>+ <wicket:fragment wicket:id="outlineOptionsFrag">+ <label class="checkbox"><input type="checkbox" wicket:id="outline" class="outline-toggle"> <wicket:t>Outline</wicket:t></label>+ </wicket:fragment>+</wicket:extend>diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/renderers/markdown/MarkdownBlobViewPanel.java b/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/renderers/markdown/MarkdownBlobViewPanel.javaindex b749e807b8..3f9623fd86 100644--- a/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/renderers/markdown/MarkdownBlobViewPanel.java+++ b/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/renderers/markdown/MarkdownBlobViewPanel.java@@ -1,33 +1,81 @@package io.onedev.server.web.page.project.blob.render.renderers.markdown;+import org.apache.wicket.behavior.AttributeAppender;import org.apache.wicket.markup.head.CssHeaderItem;import org.apache.wicket.markup.head.IHeaderResponse;+import org.apache.wicket.markup.html.WebMarkupContainer;+import org.apache.wicket.markup.html.form.CheckBox;+import org.apache.wicket.markup.html.panel.Fragment;import org.apache.wicket.model.Model;+import org.apache.wicket.request.cycle.RequestCycle;+import org.apache.wicket.request.http.WebRequest;import io.onedev.server.git.Blob;-import io.onedev.server.web.component.markdown.MarkdownViewer;+import io.onedev.server.web.component.markdown.MarkdownBlobViewer;+import io.onedev.server.web.component.markdown.MarkdownOutlinePanel;import io.onedev.server.web.page.project.blob.render.BlobRenderContext;import io.onedev.server.web.page.project.blob.render.view.BlobViewPanel;+import io.onedev.server.web.util.WicketUtils;public class MarkdownBlobViewPanel extends BlobViewPanel {+ private static final String COOKIE_OUTLINE = "markdownBlob.outline";++ private static final String COOKIE_OUTLINE_WIDTH = "markdownBlob.outline.width";++ private MarkdownOutlinePanel outline;++ private CheckBox outlineToggle;+public MarkdownBlobViewPanel(String id, BlobRenderContext context) {super(id, context);}@Overrideprotected void onInitialize() {- super.onInitialize();-Blob blob = context.getProject().getBlob(context.getBlobIdent(), true);- add(new MarkdownViewer("markdown", Model.of(blob.getText().getContent()), null) {+ var markdown = new MarkdownBlobViewer("markdown", Model.of(blob.getText().getContent()), null) {@Overrideprotected BlobRenderContext getRenderContext() {return context;}- });+ };+ outline = new MarkdownOutlinePanel("outline", markdown, true);++ super.onInitialize();++ add(markdown);+ add(outline);+ outline.setTrigger(outlineToggle);++ WebRequest request = (WebRequest) RequestCycle.get().getRequest();+ var widthCookie = request.getCookie(COOKIE_OUTLINE_WIDTH);+ String style = "width:" + (widthCookie != null ? widthCookie.getValue() : "300") + "px;";+ if (!isOutlineVisibleInitially())+ style += "display:none;";+ outline.add(AttributeAppender.replace("style", style));+ }++ @Override+ protected WebMarkupContainer newExtraOptions(String id) {+ var options = new Fragment(id, "outlineOptionsFrag", this);+ outlineToggle = new CheckBox("outline", Model.of(isOutlineVisibleInitially()));+ outlineToggle.setOutputMarkupId(true);+ outlineToggle.add(AttributeAppender.append("onchange", String.format(+ "onedev.server.markdown.toggleOutline('%s', this.checked);", outline.getMarkupId(true))));+ options.add(outlineToggle);+ return options;+ }++ private boolean isOutlineVisibleInitially() {+ WebRequest request = (WebRequest) RequestCycle.get().getRequest();+ var cookie = request.getCookie(COOKIE_OUTLINE);+ if (cookie != null)+ return cookie.getValue().equals("yes");+ else+ return !WicketUtils.isDevice();}@Overridediff --git a/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/renderers/markdown/markdown-blob.css b/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/renderers/markdown/markdown-blob.cssindex 5c477d458e..0b3f24e9b2 100644--- a/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/renderers/markdown/markdown-blob.css+++ b/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/renderers/markdown/markdown-blob.css@@ -1,5 +1,7 @@-.blob-view>.body>div>.markdown-viewer {+.markdown-blob-view>.markdown-content>.markdown-viewer {padding: 1.6rem;+}+.markdown-blob-view>.markdown-content>.markdown-viewer>.markdown-rendered {max-width: 900px;margin-left: auto;margin-right: auto;diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/overview/ProjectOverviewPage.html b/server-core/src/main/java/io/onedev/server/web/page/project/overview/ProjectOverviewPage.htmlindex ba2143c233..9729b843e2 100644--- a/server-core/src/main/java/io/onedev/server/web/page/project/overview/ProjectOverviewPage.html+++ b/server-core/src/main/java/io/onedev/server/web/page/project/overview/ProjectOverviewPage.html@@ -36,8 +36,9 @@</div></div><div wicket:id="readme" class="readme card mb-4">- <div class="card-header">+ <div class="card-header d-flex align-items-center"><div wicket:id="title" class="card-title mb-0"></div>+ <a wicket:id="outline" class="ml-auto" t:data-tippy-content="Outline"><wicket:svg href="unordered-list" class="icon"></wicket:svg></a></div><div class="card-body"><div wicket:id="body"></div>diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/overview/ProjectOverviewPage.java b/server-core/src/main/java/io/onedev/server/web/page/project/overview/ProjectOverviewPage.javaindex 647dc59c39..a21f342c2b 100644--- a/server-core/src/main/java/io/onedev/server/web/page/project/overview/ProjectOverviewPage.java+++ b/server-core/src/main/java/io/onedev/server/web/page/project/overview/ProjectOverviewPage.java@@ -79,7 +79,8 @@ import io.onedev.server.web.component.MultilineLabel;import io.onedev.server.web.component.entity.labels.EntityLabelsPanel;import io.onedev.server.web.component.issue.statestats.StateStatsBar;import io.onedev.server.web.component.link.ViewStateAwarePageLink;-import io.onedev.server.web.component.markdown.MarkdownViewer;+import io.onedev.server.web.component.markdown.MarkdownBlobViewer;+import io.onedev.server.web.component.markdown.MarkdownOutlineDropdownLink;import io.onedev.server.web.component.modal.ModalLink;import io.onedev.server.web.component.modal.ModalPanel;import io.onedev.server.web.component.project.ProjectAvatar;@@ -256,7 +257,7 @@ public class ProjectOverviewPage extends ProjectPage {}}));- readme.add(new MarkdownViewer("body", new LoadableDetachableModel<>() {+ var markdown = new MarkdownBlobViewer("body", new LoadableDetachableModel<>() {@Overrideprotected String load() {@@ -444,6 +445,15 @@ public class ProjectOverviewPage extends ProjectPage {};}+ };+ readme.add(markdown);+ readme.add(new MarkdownOutlineDropdownLink("outline") {++ @Override+ protected MarkdownBlobViewer getViewer() {+ return markdown;+ }+});add(readme);diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/overview/project-overview.css b/server-core/src/main/java/io/onedev/server/web/page/project/overview/project-overview.cssindex e661d31a83..8f72e47630 100644--- a/server-core/src/main/java/io/onedev/server/web/page/project/overview/project-overview.css+++ b/server-core/src/main/java/io/onedev/server/web/page/project/overview/project-overview.css@@ -39,8 +39,17 @@.project-overview .children .project-list > .card-body {padding: 0;}+.project-overview .readme>.card-header {+ position: sticky;+ top: 0;+ z-index: 10;+ background: inherit;+}+.project-overview .readme .header-anchor {+ scroll-margin-top: 80px;+}.project-overview .readme .markdown-viewer {max-width: 900px;margin-left: auto;margin-right: auto;-}\ No newline at end of file+}diff --git a/server-ee b/server-eeindex 7d43391827..42cb820c30 160000--- a/server-ee+++ b/server-ee@@ -1 +1 @@-Subproject commit 7d433918276de022f717986f45bb5429091d1437+Subproject commit 42cb820c30fd56ec40ce96ba7389d418ecc008ac