opentofu.org/README.md

Stack

• Docusaurus
• React
• TypeScript
• Tailwind CSS

Working with this repository

Cloning the repository

This repository uses git submodules to pull in the main OpenTofu repository. You can clone it using the following two steps:

1. Clone the repository:

git clone git@github.com:opentofu/opentofu.org.git

2. Fetch the documentation:

cd opentofu.org
git submodule init
git submodule update

Running the dev server locally

You can run the dev server if you have a local NodeJS/npm environment installed:

1. Install dependencies:

npm i

2. Start the development server:

npm run start

You can now access the site locally at http://localhost:3000/

Running the dev server in a container

You can also run the dev server in a container with the following command:

docker compose up --build