Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dschach/highlightjs-visualforce
Viisualforce - a language grammar for the Salesforce Platform
https://github.com/dschach/highlightjs-visualforce
Last synced: 3 months ago
JSON representation
Viisualforce - a language grammar for the Salesforce Platform
- Host: GitHub
- URL: https://github.com/dschach/highlightjs-visualforce
- Owner: dschach
- License: mit
- Created: 2022-06-02T03:33:43.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T19:57:49.000Z (4 months ago)
- Last Synced: 2024-10-29T21:47:24.666Z (4 months ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/highlightjs-visualforce
- Size: 193 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README

# Visualforce - a user interface framework for the [Salesforce Platform](https://developer.salesforce.com)
[](https://www.npmjs.com/package/highlightjs-visualforce)

[](https://www.npmjs.com/package/highlightjs-visualforce)
[](https://www.npmjs.com/package/highlightjs-visualforce)

[](https://github.com/dschach/highlightjs-visualforce/blob/main/LICENSE.md)
[](https://cdn.jsdelivr.net/npm/highlightjs-visualforce/dist/visualforce.min.js)[](https://github.com/dschach/highlightjs-visualforce/issues)
NOTE: Salesforce strongly encourages development using Lightning Web Components. This library is not intended to be an endorsement of VF instead of LWC, but is only a tool for highlighting web page Visualforce markup.
## Visualforce code requirements
This library will highlight Visualforce as used in Visualforce pages and components.
## Usage
Simply include the Highlight.js library in your webpage or Node app, then load this module. For more complex usage, see [highlight.js usage](https://github.com/highlightjs/highlight.js#basic-usage).
### Static website or simple usage
Simply load this module after loading Highlight.js. You'll use the minified version found in the `dist` directory. This module is just a CDN build of the language, so it will register itself as the Javascript is loaded.
For more details see [Highlight.js main page](https://github.com/highlightjs/highlight.js#highlightjs).
```html
hljs.highlightAll();
```
This will find and highlight code inside of `
` tags; it tries to detect the language automatically. If automatic detection doesn’t work for you, you can specify the language in the `class` attribute:
```html
...
```The language file will also accept `vf` as an alias for `visualforce`:
```html
...
```#### Ignoring a Code Block
To skip highlighting of a code block completely, use the `nohighlight` class:
```html
...
```### Using directly from jsDelivr
```html
```
- More info:
### Using directly from the unpkg CDN
```html
```
- More info:
### With Node or another build system
If you're using Node / Webpack / Rollup / Browserify, etc, simply require the language module, then register it with Highlight.js.
```javascript
var hljs = require('highlightjs');
var hljsVisualforce = require('highlightjs-visualforce');hljs.registerLanguage('visualforce', hljsVisualforce);
hljs.highlightAll();
```### Styles
There are many styles to choose from at [https://highlightjs.org/demo](https://highlightjs.org/demo). They can be downloaded from [the GitHub repository](https://github.com/highlightjs/highlight.js/tree/main/src/styles) and referenced from unpkg.com or jsdelivr (see sample html above).
## License
Highlight.js is released under the BSD 3-Clause License. See [LICENSE](https://github.com/highlightjs/highlight.js/blob/main/LICENSE) file for details.
Highlightjs-visualforce is released under the MIT License. See [LICENSE](/LICENSE.md) file for details.## Author
David Schach [https://github.com/dschach](https://github.com/dschach)
## Contribution
Feel free to create issues or (even better) pull requests.
## Links
- The official site for the Highlight.js library is .
- The Highlight.js GitHub project:
- Learn more about Visualforce: