Skip to content

Commit

Permalink
Merge pull request #132 from forcedotcom/teresa-cx2
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
clayparksfdc authored Oct 9, 2024
2 parents c4b83af + aa247a1 commit b149105
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,40 @@

# SLDS Validator for Visual Studio Code

This extension simplifies working with [Salesforce Lightning Design System (SLDS)](https://www.lightningdesignsystem.com/) in Aura and Lightning:
SLDS Validator scans your UI code, validates it against a database of guidelines, and provides recommendations to improve your code. The SLDS Validator extension simplifies working with [Salesforce Lightning Design System (SLDS)](https://www.lightningdesignsystem.com/) and SLDS 2.

![The SLDS Validator VS Code Extension at work!](https://media.giphy.com/media/RkbvNrnAsU3GkImW2r/source.gif)

With this extension, you get:
With the SLDS Validator extension, you get:

- SLDS and SLDS 2 support
- Validation with recommended tokens and utility classes
- Syntax highlighting
- Code completion
- Context awareness
- Bulk report generation

If you are interested in contributing, please take a look at the [CONTRIBUTING](CONTRIBUTING.md) guide.
To contribute to Validator, take a look at the [CONTRIBUTING](CONTRIBUTING.md) guide.

## Latest News
To learn about new and changed features in our latest releases, read our [release notes](https://marketplace.visualstudio.com/items/salesforce.salesforce-vscode-slds/changelog).

## Prerequisites
Before you set up the SLDS Validator, make sure that you have these essentials:
- Java. [These instructions](https://developer.salesforce.com/tools/vscode/en/getting-started/java-setup) will guide you how.
To get started with SLDS Validator, first install these essentials:

- Java. Follow [these instructions](https://developer.salesforce.com/docs/platform/sfvscode-extensions/guide/java-setup.html) to set up JDK.
- [Visual Studio Code](https://code.visualstudio.com/download) v1.26 or later

## Documentation

Documentation is currently under maintenance as we prepare a new major release. Please see the [SLDS Validator for VS Code page](https://www.lightningdesignsystem.com/tools/validator/) here for further updates.
To optimize your use of Validator, read our [documentation](https://www.lightningdesignsystem.com/tools/validator/).

## Bugs and Feedback

To report issues with Salesforce Extensions for VS Code, open a [bug on GitHub](https://github.com/forcedotcom/salesforcedx-vscode/issues/new?template=Bug_report.md). If you would like to suggest a feature, create a [feature request on GitHub](https://github.com/forcedotcom/salesforcedx-vscode/issues/new?template=Feature_request.md).
To report issues with Salesforce Extensions for VS Code, open a [bug on GitHub](https://github.com/forcedotcom/salesforcedx-vscode/issues/new?template=Bug_report.md). To suggest a feature, create a [feature request on GitHub](https://github.com/forcedotcom/salesforcedx-vscode/issues/new?template=Feature_request.md).

---

Currently, Visual Studio Code extensions are not signed or verified on the Microsoft Visual Studio Code Marketplace. Salesforce provides the Secure Hash Algorithm (SHA) of each extension that we publish. Consult [Manually Verify the salesforcedx-vscode Extensions’ Authenticity](https://developer.salesforce.com/media/vscode/SHA256.md) to learn how to verify the extensions.
Currently, Visual Studio Code extensions aren't signed or verified on the Microsoft Visual Studio Code Marketplace. Salesforce provides the Secure Hash Algorithm (SHA) of each extension that we publish. Consult [Manually Verify the salesforcedx-vscode Extensions’ Authenticity](https://developer.salesforce.com/media/vscode/SHA256.md) to learn how to verify the extensions.

---

0 comments on commit b149105

Please sign in to comment.