Terra Docs

Welcome to the official documentation for the Terra blockchain. The Terra Docs are an ever-changing compendium of guides and reference material for learning about, developing on, and running the Terra blockchain.

To contribute to this documentation, please read the Code of Conduct and the Terra Docs Style Guide before opening a pull request.

The Terra Docs represent years of hard work and upkeep to create industry-leading documentation. Many thanks to all the contributors of this repository.

Setup

Installation

$ yarn

Local Development

$ 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

$ yarn build

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

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

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.

Syntax

Admonitions

You can use admonitions by importing them and using the following syntax:

import Admonition from '@theme/Admonition';

<Admonition type="note" icon="📝" title="Your Title">

Some **content** with _markdown_ `syntax`.

</Admonition>

The icon and title values are optional.

Admonition types:

note
tip
info
caution
danger

Details

For dropdown details, use the following syntax:

<details>
<summary> Title </summary>
<p>

hidden content

</p>
</details>

Comments

{/*
this is a comment in mdx
*/}

License

This repository is licensed under the Apache license. See LICENSE for full disclosure.

© 2023 Terraform Labs, PTE