sukey2008 / cartesi-docs

SDK documentation

Cartesi Documentation

Cartesi Docs has been built using Docusaurus 2, a modern static website generator.

Requirements

• Install Node.js version >= 12.13
• Install Yarn version >= 1.5

Note that on macOS you also need Xcode and Command Line Tools.

Run the Docs locally

1. Fork the repo:

   For help, refer to GitHub Docs: Fork a repo.

2. Clone your forked repo:

   git clone [e-mail]:[your_github_handle]/cartesi/docs
   

3. Navigate into the cloned folder:

   cd docs
   

4. If you have already cloned the repository, be sure to sync your fork with the latest changes:

   For help, refer to GitHub Docs: Syncing a fork.

   git checkout master
   git pull
   

5. Install the dependencies:

   yarn install
   

   The site is built using Docusaurus. You may need to install Docusaurus before running the Docs locally.

   yarn add docusaurus
   

   Alternatively, you can upgrade Docusaurus.

   yarn upgrade @docusaurus/core@latest @docusaurus/preset-classic@latest
   

6. Run the Docs locally: The following command will start a local development server and open a browser window. Most changes are reflected live without having to restart the server.

   yarn start
   

And then point your browser to http://localhost:3000.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents 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
master	https://github.com/cartesi/docs

Project Structure

• Learn Markdown features
• Understand docs structure rundown