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

docs: Syntax highlighting in editor could be improved #52654

Open
3 tasks
atscott opened this issue Sep 27, 2023 · 3 comments
Open
3 tasks

docs: Syntax highlighting in editor could be improved #52654

atscott opened this issue Sep 27, 2023 · 3 comments
Assignees
Labels
area: adev Angular.dev documentation area: docs-infra Angular.dev application and infrastructure good first issue An issue that is suitable for first-time contributors; often a documentation issue. help wanted An issue that is suitable for a community contributor (based on its complexity/scope). P1 Impacts a large percentage of users; if a workaround exists it is partial or overly painful
Projects
Milestone

Comments

@atscott
Copy link
Contributor

atscott commented Sep 27, 2023

Syntax highlighting in the editor could/should be improved for Angular templates

Places where highlighting could be applied better:

  • interpolations / expressions
  • attribute and event bindings
  • the new control flow/block syntaxes

Here is an image of the current editor in the playground where you can see that none of the above get any special treatment:

image
@twerske twerske added the P1 Impacts a large percentage of users; if a workaround exists it is partial or overly painful label Sep 27, 2023
@twerske twerske closed this as completed Oct 2, 2023
@atscott atscott reopened this Oct 2, 2023
@sn-kaier sn-kaier self-assigned this Oct 5, 2023
@twerske twerske changed the title Syntax highlighting in editor could be improved docs: Syntax highlighting in editor could be improved Oct 28, 2023
@josephperrott josephperrott added P0 Issue that causes an outage, breakage, or major function to be unusable, with no known workarounds P2 The issue is important to a large percentage of users, with a workaround bug area: adev Angular.dev documentation and removed P0 Issue that causes an outage, breakage, or major function to be unusable, with no known workarounds P1 Impacts a large percentage of users; if a workaround exists it is partial or overly painful P2 The issue is important to a large percentage of users, with a workaround bug labels Nov 8, 2023
@ngbot ngbot bot added this to the needsTriage milestone Nov 8, 2023
@josephperrott josephperrott transferred this issue from another repository Nov 8, 2023
@twerske twerske added area: docs-infra Angular.dev application and infrastructure good first issue An issue that is suitable for first-time contributors; often a documentation issue. and removed area: adev Angular.dev documentation labels Nov 8, 2023
@twerske twerske modified the milestones: needsTriage, Backlog Nov 9, 2023
@ngbot ngbot bot modified the milestones: Backlog, needsTriage Nov 9, 2023
@twerske twerske modified the milestones: needsTriage, Backlog Nov 9, 2023
@ngbot ngbot bot modified the milestones: Backlog, needsTriage Nov 9, 2023
@ngbot ngbot bot modified the milestones: Backlog, needsTriage Nov 9, 2023
@twerske twerske modified the milestones: needsTriage, Backlog Nov 9, 2023
@ngbot ngbot bot modified the milestones: Backlog, needsTriage Nov 9, 2023
@twerske twerske added area: adev Angular.dev documentation help wanted An issue that is suitable for a community contributor (based on its complexity/scope). labels Nov 9, 2023
@twerske twerske added the P2 The issue is important to a large percentage of users, with a workaround label Nov 29, 2023
@ngbot ngbot bot modified the milestones: needsTriage, Backlog Nov 29, 2023
@mgechev mgechev added this to To do in adev Feb 1, 2024
@niklas-wortmann
Copy link
Contributor

niklas-wortmann commented Mar 26, 2024

Just putting this out here again. Shiki has support for all the things above as you can see in the screenshot below. It also uses the textmate grammar files directly from here https://github.com/angular/vscode-ng-language-service/tree/main/syntaxes, so it will always be up to date in case we get control-flow/block syntax v2 (just kidding :D)
image

As I stated in the referenced ticket, I did migrate a couple websites within JetBrains over to Shiki so I'd be more than happy to help out here, if interested

@surajchopra1234
Copy link

image

  • Angular.dev docs have too low contrast between the text and the background.
  • The background is pitch black, which is very irritating to the eyes.
  • The links are not visually distinct enough to be easily recognizable as clickable elements.
  • The blue color isn't bright enough to differentiate between itself and the pink in the code block.

@mgechev mgechev added P1 Impacts a large percentage of users; if a workaround exists it is partial or overly painful and removed P2 The issue is important to a large percentage of users, with a workaround labels May 6, 2024
@mgechev
Copy link
Member

mgechev commented May 6, 2024

Updated to P1. It's not a regression compared to angular.io, but creates the impression that Angular templates are just plain strings without any text editor/IDE support.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: adev Angular.dev documentation area: docs-infra Angular.dev application and infrastructure good first issue An issue that is suitable for first-time contributors; often a documentation issue. help wanted An issue that is suitable for a community contributor (based on its complexity/scope). P1 Impacts a large percentage of users; if a workaround exists it is partial or overly painful
Projects
adev
To Do
Development

No branches or pull requests

7 participants