Skip to content

Commit

Permalink
Bump docs site
Browse files Browse the repository at this point in the history
  • Loading branch information
evinism committed Oct 8, 2024
1 parent ef11f89 commit 14f31da
Show file tree
Hide file tree
Showing 20 changed files with 18,827 additions and 12,980 deletions.
17,219 changes: 17,219 additions & 0 deletions docs/package-lock.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"@svgr/webpack": "^5.5.0",
"clsx": "^1.1.1",
"file-loader": "^6.2.0",
"mistql": "0.4.11",
"mistql": "0.4.12",
"prism-react-renderer": "^1.2.1",
"react": "^17.0.1",
"react-dom": "^17.0.1",
Expand Down
56 changes: 56 additions & 0 deletions docs/versioned_docs/version-0.4.12/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
sidebar_position: 1
---

# Getting Started

MistQL is a miniature language for performing computations on JSON-like structures.

MistQL's JavaScript implementation is built from the ground up to be included in clientside browser applications. It has no dependencies and has a total footprint of 5.3kB gzipped, making it suitable for size-sensitive frontends.

## Installation

The JavaScript implementation of MistQL is installed via the following:

```shell
npm install --save mistql
```

The Python implementation of MistQL is installed via the following:

```shell
pip install mistql
```

## Code usage

MistQL's primary interface is through programatic access:

```js
// JavaScript
import mistql from 'mistql';

const query = 'events | filter type == "purchase" | groupby email | keys';
const purchaserEmails = mistql.query(query, data);
```

```py
# Python
import mistql

query = 'events | filter type == "purchase" | groupby email | keys'
purchaserEmails = mistql.query(query, data)
```

## Command line usage

MistQL exposes a command line interface under the name `mq`. `mq` can be installed globally via `npm install -g mistql`.

The CLI can be used via `mq <query> [file]`

If file is not provided, `mq` defaults to `stdin`. An example usage might be the following:

```sh
$ echo "[]" | mq "count @"
> 0
```
4 changes: 4 additions & 0 deletions docs/versioned_docs/version-0.4.12/reference/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Reference",
"position": 3
}
Loading

0 comments on commit 14f31da

Please sign in to comment.