[go: up one dir, main page]

Skip to content

Make Markdown preview more obvious/enabled by default in the new Web IDE

Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.

Problem

The old Web IDE provides two tabs for the Markdown file type: Edit and Preview Markdown.

image

The new Web IDE based on VS Code makes it harder to find the Markdown preview. Either you know how to access the command palette action, or the keyboard shortcuts, or the small button in the IDE.

image

image

Following @Rwarcards762 from #385787 (comment 1223072402)

the Markdown Previewer built in to VSCode, just like in the Desktop version, can be opened with CTRL + SHIFT + V / CTRL + K, V as well for a quick shortcut to preview the current file. 🚀

The Preview button does exist, up at the top right, if you know where to look for it.

HOWEVER -- that does not make it ANYWHERE near as obvious as the original GitLab Web IDE, and for those less code-savvy, this is a clear feature regression (IMO.) If there's an issue open to track making the ability to preview Markdown more obvious, I'd love to track -- if someone could link it.

I think that these small QoL improvements will be a core component to letting VSCode drop in-place of the current Web IDE without requiring teaching everyone how to use VSCode.

cc @ericschurter @mvanremmerden

Proposal

  1. Make it more obvious how to preview Markdown file types (i.e. by guided introductions for the UI inspired by #365666 (closed))
  2. Consider opening a Markdown preview pane automatically when opening a Markdown file.
    • Make this configurable since not every user has the window space to have 2 panes open.

image

Edited by 🤖 GitLab Bot 🤖