# [zkSync Lite Docs](https://docs.lite.zksync.io/) ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/matter-labs/zksync-lite-docs) ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/matter-labs/zksync-lite-docs/Deploy%20production)

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/matter-labs/zksync-lite-docs/blob/master/LICENSE) [![npm version](https://img.shields.io/npm/v/zksync.svg?style=flat)](https://www.npmjs.com/package/zksync) [![Follow us!](https://img.shields.io/twitter/follow/zksync?color=%238C8DFC&label=Follow%20%40zkSync&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64% %2BCjwvc3ZnPgo%3D&style=flat)](https://twitter.com/zksync)


## zkSync Documentation for the v1 | [CHANGELOG](./CHANGELOG.md)

This repository contains the zkSync documentation hosted at [docs.lite.zksync.io/](https://docs.lite.zksync.io/)

## Development

### Prerequisites

A [Node.js](https://nodejs.org/en/download) installation running Node.js version 16.

### Local run

```bash
yarn install --check-cache
yarn docs:dev
```

### Development

CI pipeline will check that the files are formatted according `markdownlint` founds no issues in document
and spelling is correct. Also, there should be no dead links.

You can check it locally as follows:

```bash
yarn
yarn md:lint
yarn cspell
```

If `cspell` doesn't recognize a word but you're sure that it's correct, consider adding it to the `cspell-zksync.txt`.

## Deployment

`master` branch is automatically deployed to <https://console.firebase.google.com/u/0/project/zksync-web-docs>

### Deploying altogether

> will do:

* install node modules;
* prepare, test and build documentation;
* afterwards all contained into the `dist` folder will be deployed in form of the static website

```bash
yarn install --check-cache
yarn docs:build
yarn firebase deploy
```

## Extra documentation

## cSpell

Configuration in `cspell.json`:

* `version` — version of the setting file, always **0.1**
* `language` — language - current active spelling language
* `words[]` — words - list of words to be always considered correct
* `dictionaries[]`

```
"dictionaryDefinitions": [
    {
      "name": "zksync", "path": "./cspell-zksync.txt"
    }
]
```

```bash
{
  "version": "0.1",
  // language - current active spelling language
  "language": "en",
  // words - list of words to be always considered correct
  "words": [],
  "dictionaries": ["typescript", "zksync"],
  //
  "dictionaryDefinitions": [
  {
    "name": "zksync", "path": "./cspell-zksync.txt"
  }
]
}
```

---

# ZKsync Ecosystem

- [**Start building with ZKsync v2 🚀**](https://portal.zksync.io)
- [Integration Docs](https://docs.lite.zksync.io/dev)
- [Available API & protocols](https://docs.lite.zksync.io/api/)
- [zkWallet](https://lite.zksync.io/)
- [Alternative Withdrawal](https://withdraw.zksync.io/)
- [zkScan](https://zkscan.io/)
- [’out-of-gas’ issue solver ](https://withdraw.zksync.io/)

---

- [Matter Labs: creators of the ZKsync](https://matter-labs.io)
- [ZKsync  Homepage](https://zksync.io)

---
> BTW, we're hiring: [See open positions](https://joinmatterlabs.com)

## License

zkWallet is distributed under the terms of both the MIT license, and the Apache License (v.2.0).

See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT) for details.
