Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jeremyruppel committed Oct 21, 2023
1 parent d165743 commit 570648e
Show file tree
Hide file tree
Showing 38 changed files with 4,877 additions and 13 deletions.
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# tslogic

Type defitions for Logic Pro' Scripter. Check out the [API Docs](./docs)

### usage

Create a `tsconfig.json` withe following compiler options:

```json
{
"compilerOptions": {
"outDir": "<where you want your scripts written out>",
"target": "ES6",
"skipLibCheck": true
},
"include": ["<your source files>"]
}
```

If you don't have one, create a `package.json`:

```
$ npm init -y
```

Install `tslogic` as a devDependency of your project:

```
$ npm install --save-dev tslogic
```

Finally, in your typescript source files, reference the `tslogic` types like:

```ts
/// <reference types="tslogic" />
```
1 change: 1 addition & 0 deletions docs/.nojekyll
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.
22 changes: 22 additions & 0 deletions docs/assets/highlight.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
:root {
--light-code-background: #FFFFFF;
--dark-code-background: #1E1E1E;
}

@media (prefers-color-scheme: light) { :root {
--code-background: var(--light-code-background);
} }

@media (prefers-color-scheme: dark) { :root {
--code-background: var(--dark-code-background);
} }

:root[data-theme='light'] {
--code-background: var(--light-code-background);
}

:root[data-theme='dark'] {
--code-background: var(--dark-code-background);
}

pre, code { background: var(--code-background); }
59 changes: 59 additions & 0 deletions docs/assets/main.js

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/assets/navigation.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions docs/assets/search.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 570648e

Please sign in to comment.