Skip to content

Commit 16e8170

Browse files
committed
docs(updated some documentations): added missing issue templates, updated documentation
1 parent e54240b commit 16e8170

6 files changed

Lines changed: 267 additions & 210 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,35 @@ about: Create a report to help me fix it
44
title: Simple description of the bug
55
labels: bug
66
assignees: ghaschel
7-
87
---
98

10-
Please provide the maximum amount of information in order for me to be able to fix it quicker
9+
Please provide the maximum amount of information in order for me to be able to fix it quicker.
10+
11+
Please, read the [F.A.Q.](../../docs/FAQ.md) before. Your bug might not be a bug.
12+
13+
**Have you read the F.A.Q.?**
14+
15+
- [ ] No
16+
- [ ] Yes, but my issue has nothing to do with anything in there, or it does but something is broken.
1117

1218
**Describe the bug**
13-
- A clear and concise description of what the bug is.
19+
20+
- A clear and concise description of what the bug is.
1421

1522
**List of installed/enabled extensions**
1623
Provide a list of installed/enabled extensions. Also, try to pinpoint which extension might be conflicting with the current one if that's the case.
17-
- Provide an extension list screenshot of extensions ids [e.g. `ghaschel.vscode-angular-html`]
24+
25+
- Provide an extension list screenshot of extensions ids [e.g. `ghaschel.vscode-angular-html`]
1826

1927
**OS (please provide the following information):**
20-
- OS and Version: [e.g. Windows 10/11, Ubuntu 18.04, MacOS Catalina]
21-
- VSCode version
28+
29+
- OS and Version: [e.g. Windows 10/11, Ubuntu 18.04, MacOS Catalina]
30+
- VSCode version
2231

2332
**Expected behavior**
24-
- A clear and concise description of what you expected to happen.
33+
34+
- A clear and concise description of what you expected to happen.
2535

2636
**Additional context**
27-
- Add any other context about the problem here. [e.g. extension Y is not being used at its latest version, but instead, version x.y.z]
37+
38+
- Add any other context about the problem here. [e.g. extension Y is not being used at its latest version, but instead, version x.y.z]

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@
1212
<img src="assets/angular-html.png" title="vscode-angular-html" alt="Logo" />
1313
</div>
1414

15+
> Note: No theme will have the highlighting displayed in these images. For that effect, run the `vscode-angular-html: Set legacy color customizations` command from the command pallete and you're good to go.
16+
1517
## Angular HTML Template Syntax Highlighting
1618

1719
This plugin adds syntax highlighting for angular HTML template files in VS Code. It supports the angular syntax itself, HTML DOM events, SVG, XML (with DTD and namespaces support), emphasizes deprecated and obsolete tags and attributes usage according to the current status of HTML. Also supports custom colors for extra-matched scopes. See [color customizations](docs/COLOR-CUSTOMIZATIONS.MD)
1820

19-
> Note: VSCode's default Dark+ theme doesn't have the highlighting displayed in these images. For that effect, run the `vscode-angular-html: Set legacy color customizations` command".
20-
2121
# Summary
2222

2323
- [vscode-angular-html](#vscode-angular-html)

docs/FAQ.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Frequently Asked Questions
2+
3+
> This document will cover all the most asked questions so far.
4+
5+
- [Frequently Asked Questions](#frequently-asked-questions)
6+
- [My Highlighting is not working as in previous versions.](#my-highlighting-is-not-working-as-in-previous-versions)
7+
- [How can I request a new theme, or a change to an already supported theme?](#how-can-i-request-a-new-theme-or-a-change-to-an-already-supported-theme)
8+
9+
## My Highlighting is not working as in previous versions.
10+
11+
This extension was written a long time ago, when I didn't know much of what I was doing with TextMate Grammars, so I wrote it just to get some light in my undistinguable-from-html Angular templates. But that caused it to only work greatly with a few themes, and thus, not being everyone's cup of tea. So in order to be able to make it customizable, I have added a Settings session, in which you can change all of your extra-matched characters colors so that it fits exactly to your taste. Please, bear in mind that this will not theme-specific. If you change a theme, you might need to edit again. That said, there is a alternative for those who just want to get the legacy colors customizations back on. You can run the `vscode-angular-html: Set legacy colors customizations` command in the command pallete, and it will work just as before. For the list of supported themes for the legacy colors customization, refer to [supported themes](SUPPORTED-THEMES.md).
12+
13+
## How can I request a new theme, or a change to an already supported theme?
14+
15+
Please, follow [this link](https://github.com/ghaschel/vscode-angular-html/issues/new?assignees=ghaschel&labels=theme+support&template=theme_support.md&title=Support+extra-matched+characters+colors+for+XYZ+theme).

docs/SUPPORTED-THEMES.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Custom Scope Names
2+
3+
> Here you can find the list of supported themes.
4+
> If you want to ask for support for a specific theme, please refer to the [F.A.Q.](FAQ.md).
5+
6+
## Supported Themes
7+
8+
- [C/C++ Themes](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools-themes)
9+
- [One Dark Pro](https://marketplace.visualstudio.com/items?itemName=zhuangtongfa.Material-theme)
10+
- [Github Theme](https://marketplace.visualstudio.com/items?itemName=GitHub.github-vscode-theme)
11+
- [Dracula Official](https://marketplace.visualstudio.com/items?itemName=dracula-theme.theme-dracula)
12+
- [Atom One Dark Theme](https://marketplace.visualstudio.com/items?itemName=akamud.vscode-theme-onedark)
13+
- [Community Material Theme](https://marketplace.visualstudio.com/items?itemName=Equinusocio.vsc-community-material-theme)
14+
- [Winter Is Coming Theme](https://marketplace.visualstudio.com/items?itemName=johnpapa.winteriscoming)
15+
- [Monokai Pro](https://marketplace.visualstudio.com/items?itemName=monokai.theme-monokai-pro-vscode)
16+
- [Night Owl](https://marketplace.visualstudio.com/items?itemName=sdras.night-owl)
17+
- [Material Theme](https://marketplace.visualstudio.com/items?itemName=Equinusocio.vsc-material-theme)
18+
- [Ayu](https://marketplace.visualstudio.com/items?itemName=teabyii.ayu)
19+
- [One Monokai Theme](https://marketplace.visualstudio.com/items?itemName=azemoh.one-monokai)
20+
- [SynthWave '84](https://marketplace.visualstudio.com/items?itemName=RobbOwen.synthwave-vscode)
21+
- [Visual Studio 2019 Theme](https://marketplace.visualstudio.com/items?itemName=kast789.vs-2019-theme)
22+
- [Monokai Dark Soda](https://marketplace.visualstudio.com/items?itemName=AdamCaviness.theme-monokai-dark-soda)
23+
- [Darcula Theme - WebStorm Edition](https://marketplace.visualstudio.com/items?itemName=rexebin.dracula)
24+
- [Dark Purple - WebStorm Edition](https://marketplace.visualstudio.com/items?itemName=rexebin.darkpurple)
25+
- [Darcula Theme - Black Edition](https://marketplace.visualstudio.com/items?itemName=rexebin.dracula-black)
26+
- [Dark Purple - Black Edition](https://marketplace.visualstudio.com/items?itemName=rexebin.darkpurple-black)
27+
- [One Dark Pro Monokai Darker Theme](https://marketplace.visualstudio.com/items?itemName=eserozvataf.one-dark-pro-monokai-darker)
28+
- All the default ones
29+
- Generic Fallback

docs/THEMING.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Custom Scope Names
22

3-
> This file aims to be used as a way to point out the extra-matched scopes for themes to be able to support them
3+
> This file aims to be used as a way to point out the extra-matched scopes for themes to be able to support them.
4+
5+
> This extension also has support for specific themes when enabling legacy colors customization, and as a fallback, it **_tries_** to generate a color-pallete based on the current theme. For the list of supported themes, please refer to [supported themes](SUPPORTED-THEMES.md).
46
57
## Summary
68

0 commit comments

Comments
 (0)