Skip to content

Syntax highlighting for README #38

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jan 11, 2019
Merged

Syntax highlighting for README #38

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ TAG was developed by Angus Forbes (UC Santa Cruz) and Kristine Lee (University o

If you use TAG in your work, please use the following citation:

```
```TeX
@inproceedings{TAG-2018,
author = {Angus Forbes and Kristine Lee and Gus Hahn-Powell and Marco A. Valenzuela-Escárcega and Mihai Surdeanu},
title = {Text Annotation Graphs: Annotating Complex Natural Language Phenomena},
Expand All @@ -47,7 +47,7 @@ TAG can be built and installed using [`npm`](https://docs.npmjs.com/getting-star

### Via `npm`

```
```JavaScript
npm install git+https://github.com/CreativeCodingLab/TextAnnotationGraphs.git
```

Expand All @@ -57,19 +57,19 @@ To use TAG with your own applications, first include the library in your script:

#### Browserify (CommonJS)

```
```JavaScript
const TAG = require("text-annotation-graphs");
```

#### ES6

```
```JavaScript
import TAG from "text-annotation-graphs";
```

Then initialise the visualisation on an element, optionally specifying the initial data set to load and any overrides to the default options. For more details, consult the [full API documentation](docs/index.html).

```
```JavaScript
const graph = TAG.tag({
container: $container,
data: {...},
Expand Down Expand Up @@ -121,6 +121,6 @@ TAG uses [JSDoc](http://usejsdoc.org/) to generate its documentation. By default

To regenerate the documentation, use the following `npm` task:

```
```javscript
npm run generate-docs
```