@leitmotif-dev/highlightjs-pbxproj/README.md

highlight.js grammar for Apple Xcode Project (.pbxproj) files

# pbxproj - a language grammar for highlight.js

![version](https://badgen.net/npm/v/@leitmotif-dev/highlightjs-pbxproj) ![license](https://badgen.net/badge/license/MIT/blue)
![install size](https://badgen.net/packagephobia/install/@leitmotif-dev/highlightjs-pbxproj)

## Description

This is a language grammar for highlight.js (version 11.x) that highlights Xcode Project (.pbxproj) files as written by [Apple Xcode](https://developer.apple.com/xcode/).

## Usage

Include the Highlight.js library in your webpage or Node app, then load this module.

### Static website or simple usage

Load the 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.

```html
<script type="text/javascript" src="/path/to/highlight.min.js"></script>
<script type="text/javascript" src="/path/to/pbxproj.js"></script>
<script type="text/javascript">
  hljs.highlightAll();
</script>
```

### Using directly from the UNPKG CDN

```html
<script type="text/javascript"
  src="https://unpkg.com/@leitmotif-dev/highlightjs-pbxproj@1.0.1/dist/pbxproj.min.js"></script>
```

- More info: <https://unpkg.com>

### 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('highlight.js');
var hljsPbxproj = require('highlightjs-pbxproj');

hljs.registerLanguage("pbxproj", hljsPbxproj);
hljs.highlightAll();
```

## License

Highlight.js is released under the MIT License. See [LICENSE][1] file
for details.

### Author

Leitmotif GmbH <hello@leitmotif.dev>

### Maintainers

- Florian Albrecht <florian@leitmotif.dev>
- Michael Ehrmann <michael@leimotif.dev>

## Links

- The official site for the Highlight.js library is <https://highlightjs.org/>.
- The Highlight.js GitHub project: <https://github.com/highlightjs/highlight.js>
- Some information on the file format: <http://www.monobjc.net/xcode-project-file-format.html>

[1]: https://github.com/leitmotif-dev/highlightjs-pbxproj/blob/master/LICENSE