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

preferences: render 'markdownDescription' as markdown #7742

Closed
vince-fugnitto opened this issue May 5, 2020 · 2 comments · Fixed by #10431
Closed

preferences: render 'markdownDescription' as markdown #7742

vince-fugnitto opened this issue May 5, 2020 · 2 comments · Fixed by #10431
Labels
enhancement issues that are enhancements to current functionality - nice to haves preferences issues related to preferences

Comments

@vince-fugnitto
Copy link
Member

vince-fugnitto commented May 5, 2020

Prerequisite:

Following #7105

Feature Description:

It is possible to define a markdownDescription property for preferences in the schema, which is ultimately used as a description of the preference including the tooltip (when editing JSON), and in the user-interface. In the user-interface, the markdownDescription should be properly rendered as markdown similarly to VS Code:

Theia:

Screen Shot 2020-05-05 at 9 17 33 AM

VS Code:

Screen Shot 2020-05-05 at 9 23 04 AM

@vince-fugnitto vince-fugnitto added enhancement issues that are enhancements to current functionality - nice to haves preferences issues related to preferences labels May 5, 2020
jwebstar added a commit to jwebstar/theia that referenced this issue Jun 24, 2021
. Note: internal settings anchor links not working yet.
jwebstar added a commit to jwebstar/theia that referenced this issue Jun 24, 2021
. Note: internal settings anchor links not working yet.
@jwebstar
Copy link

I started on this while looking at the new preferences UI and have made some progress:

Before:
PrefBefore

After:
PrefAfter

But I haven't got the internal settings links working yet. Rather than scrolling to that preference, clicking a link currently appends the id to the url instead. Before resuming with it I wanted to check:

  1. If anyone has any guidance on how this should be done?
  2. That nobody was already working on this?

@vince-fugnitto
Copy link
Member Author

@jwebstar sorry for getting back so late, it already looks like some great progress! 👍

  1. If anyone has any guidance on how this should be done?

I haven't looked at it closely yet as what we could do but we can probably use the same idea we had in #9318 to give the links the role of buttons and attempt to scroll-to the proper preference. Still, please feel free to open a draft pull-request with the changes so far and perhaps others can help.

  1. That nobody was already working on this?

Not that I know of :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement issues that are enhancements to current functionality - nice to haves preferences issues related to preferences
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants