Skip to content
Open
Changes from all commits
Commits
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
68 changes: 48 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,52 +1,80 @@
# Manta Network Documentations
# Manta Network Documentation

Manta Network is the multi-modular ecosystem for zero-knowledge (ZK) applications.Content in [docs.manta.network](https://docs.manta.network). This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## Installation
Manta Network is a multi-modular ecosystem for zero-knowledge (ZK) applications. This documentation is available at [docs.manta.network](https://docs.manta.network).

## 📋 About

This repository contains the official Manta Network documentation. The website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

## 🚀 Quick Start

### Prerequisites

- Node.js (version 14 or higher)
- Yarn

### Installation

```console
yarn install
```

## Local Development
### Local Development

```console
yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

## Build
### Build

```console
yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

## Deployment
## 🌐 Localization

We use [Translate plugin data](https://docusaurus.io/docs/i18n/tutorial#translate-plugin-data) for managing translations.

### Available Languages:
- English (default)
- Italian (it)
- Chinese (cn)

### Running Localized Versions

Italian version:
```console
GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
yarn run start --locale it
```

Chinese version:
```console
yarn run start --locale cn
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
Translations are located in the `i18n/{locale}` directory.

## Translation
## 📦 Deployment

For the translation, we're using the [Translate plugin data](https://docusaurus.io/docs/i18n/tutorial#translate-plugin-data)
```console
GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
```

Commands
For GitHub Pages hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

Run the Italian version
## 🤝 How to Contribute

```
yarn run start --locale it
```
1. Fork the repository
2. Create a branch for your changes
3. Make your changes and commit them
4. Submit a pull request

Or cn
```
yarn run start --locale cn
```
## 📝 License

Translate the markdown under **i18n/it** for the italian language.
MIT License - see the [LICENSE](LICENSE) file for details.