Skip to content

Latest commit

 

History

History
executable file
·
60 lines (36 loc) · 1.58 KB

README.md

File metadata and controls

executable file
·
60 lines (36 loc) · 1.58 KB
Raw

Cartesi Documentation

Welcome to the official Cartesi documentation repository. This documentation is built using Docusaurus 2.4.3.

Requirements

  • Install Node.js version >= 20.x
  • Install Yarn version >= 1.5

Installation

Fork, clone the repository and install dependencies:

yarn install

Local Development

The following command will start a local development server on http://localhost:3000 and open a browser window. Most changes are reflected live without having to restart the server.

yarn start

Build

To create a production build:

yarn build

This command generates static content in the build directory, which can be served using any static content hosting service.

Deployment

This repo build is automatically deployed using AWS Amplify.

The following branches and pull requests are deployed to the following URLs:

Branch URL
main https://github.com/cartesi/docs

Project Structure

Contributing

We welcome contributions to improve the documentation! Please see the Contributing Guide for more details.

License

This project is licensed under the Apache 2.0 License.