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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Notebook UI heading tweaks #188117

Merged
merged 2 commits into from
Jul 18, 2023
Merged

Conversation

christian-bromann
Copy link
Contributor

@christian-bromann christian-bromann commented Jul 17, 2023

Hi there 馃憢

I am Christian and part of the development team that has build a VS Code extension called Runme. It is an extension that renders markdown files as notebooks and allows them to execute/run the code snippets in their. Runme is currently featured on the VS Code Marketplace and grows fast day by day.

Some of the feedback we have received is that the markdown within notebooks doesn't render the same way markdown preview extension would render it. Here is example:

Markdown Example rendered in VS Code notebook view

Screenshot 2023-07-17 at 14 55 06

Markdown Example rendered with Markdown Preview Enhanced
Screenshot 2023-07-17 at 15 42 44

We have been looking at many markdown preview extensions and we see the UI diverging mostly in the following areas:

  • headings are generally too big
  • size difference between h5 and h6 too significant
  • headings have no bottom border
  • <hr /> element height is too big (2px vs. 1px)

I am proposing some small tweaks to the markdown-language-features extension that adjusts the styles so that it comes marginally closer to how VS Code would render markdown usually.

See a preview here:
vscode-ui-tweak

It lowers the visual difference between viewing markdown within a markdown preview extension or within the notebook UI.

Happy to answer any questions.
Thanks for reviewing.

@christian-bromann
Copy link
Contributor Author

@microsoft-github-policy-service agree company="Stateful Inc."

@daviddossett
Copy link
Contributor

Not sure if you saw this but I recently updated the markdown styles in VS Code itself in #185801. I think it would make more sense to align to those vs. an extension.

@christian-bromann
Copy link
Contributor Author

@daviddossett thanks for the reply! I have not seen that commit but we almost made the same change. I pushed another commit to make it more align with your changes. Wdyt?

Copy link
Contributor

@daviddossett daviddossett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@mjbvz mjbvz enabled auto-merge (squash) July 18, 2023 17:38
@mjbvz mjbvz merged commit e055922 into microsoft:main Jul 18, 2023
6 checks passed
@christian-bromann christian-bromann deleted the cb-notebook-ui-tweaks branch July 18, 2023 17:41
rebornix added a commit that referenced this pull request Jul 20, 2023
rebornix added a commit that referenced this pull request Jul 20, 2023
@github-actions github-actions bot locked and limited conversation to collaborators Sep 1, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants