Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matter-labs/zksync-lite-docs
zkSync documentation
https://github.com/matter-labs/zksync-lite-docs
docs ethereum team-core team-frontend vue vuepress zksync zksync-web
Last synced: about 1 month ago
JSON representation
zkSync documentation
- Host: GitHub
- URL: https://github.com/matter-labs/zksync-lite-docs
- Owner: matter-labs
- License: mit
- Created: 2020-04-09T08:11:13.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-02-16T05:33:22.000Z (5 months ago)
- Last Synced: 2024-02-21T01:38:37.116Z (5 months ago)
- Topics: docs, ethereum, team-core, team-frontend, vue, vuepress, zksync, zksync-web
- Language: Shell
- Homepage: https://zksync.io/dev
- Size: 67.3 MB
- Stars: 560
- Watchers: 43
- Forks: 435
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Lists
- best-of-crypto - GitHub - 58% open · ⏱️ 12.01.2024): (Others)
README
# [zkSync Lite Docs](https://docs.zksync.io/)  
[](https://github.com/matter-labs/zksync-docs/blob/master/LICENSE) [](https://www.npmjs.com/package/zksync) [](https://twitter.com/zksync)
## zkSync Documentation for the v1 | [CHANGELOG](./CHANGELOG.md)
This repository contains the zkSync documentation hosted at [docs.zksync.io](https://docs.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
### 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://zksync.io/dev)
- [Available API & protocols](https://zksync.io/api/)
- [zkWallet](https://lite.zksync.io/)
- [zkMint](https://mint.zksync.dev/)
- [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 Lite 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.