mirror of
https://github.com/opentofu/opentofu.org.git
synced 2026-01-16 23:00:26 +00:00
The OpenTofu Website
|
|
||
|---|---|---|
| .github | ||
| .husky | ||
| blog | ||
| opentofu-repo | ||
| src | ||
| static | ||
| versioned_docs | ||
| versioned_sidebars | ||
| .eslintignore | ||
| .eslintrc.js | ||
| .gitignore | ||
| .gitmodules | ||
| babel.config.js | ||
| docker-compose.yaml | ||
| Dockerfile | ||
| docusaurus.config.ts | ||
| faq.mdx | ||
| LICENSE | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| sidebars.json | ||
| supporters.json | ||
| sync-supporters.js | ||
| tailwind.config.js | ||
| tsconfig.json | ||
| versions.json | ||
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:
- Clone the repository:
git clone git@github.com:opentofu/opentofu.org.git
- 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:
- Install dependencies:
npm i
- 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
Contributing
When you contribute code to OpenTofu, do not forget to sign off your commits as described here.