The OpenTofu Website
Find a file
Janos 80f7dbf0ff
Adding build container (#220)
This commit adds a build container to make it easier for people without
NodeJS/npm to run the website locally.

Signed-off-by: Janos Bonic <86970079+janosdebugs@users.noreply.github.com>
2023-11-29 14:44:06 +00:00
.github Move main repo to a submodule to enable live editing (#214) 2023-11-28 14:32:58 +00:00
.husky Set up prettier + precommit hook (#162) 2023-09-20 12:45:52 +02:00
blog add missing truncate (#211) 2023-11-14 10:29:26 +01:00
docs Simplify page titles (#135) 2023-09-19 13:22:24 +02:00
opentofu-repo@2d5d4b4b14 Fixing broken docs entry page (#221) 2023-11-28 16:56:01 +00:00
plugins Set up prettier + precommit hook (#162) 2023-09-20 12:45:52 +02:00
src fix max-width on wide screens (#207) 2023-11-02 19:47:12 +01:00
static Update slack link. 2023-11-17 12:22:42 +01:00
.eslintignore Add eslintignore and remove eslint from precommit hook (#168) 2023-09-20 15:53:50 +02:00
.eslintrc.js Set up ESLint (#163) 2023-09-20 14:07:55 +02:00
.gitignore Move main repo to a submodule to enable live editing (#214) 2023-11-28 14:32:58 +00:00
.gitmodules Move main repo to a submodule to enable live editing (#214) 2023-11-28 14:32:58 +00:00
babel.config.js Set up docusaurus (#1) 2023-08-30 13:52:34 +02:00
docker-compose.yaml Adding build container (#220) 2023-11-29 14:44:06 +00:00
Dockerfile Adding build container (#220) 2023-11-29 14:44:06 +00:00
docusaurus.config.js Issue opentofu/opentofu#859: Redirecting old installation docs (#217) 2023-11-28 17:13:38 +00:00
faq.mdx Update versions in faq (#197) 2023-11-02 14:09:26 +00:00
package-lock.json Adding raw-loader to support including files in the documentation (#213) 2023-11-16 15:08:07 +00:00
package.json Adding raw-loader to support including files in the documentation (#213) 2023-11-16 15:08:07 +00:00
README.md Adding build container (#220) 2023-11-29 14:44:06 +00:00
sidebars.js Simplify docs nav (#82) 2023-09-15 18:24:30 +02:00
supporters.json Update supporters (#187) 2023-10-16 22:57:34 +02:00
sync-supporters.js add empty line when generating supporters.json (#178) 2023-09-22 15:18:38 +02:00
tailwind.config.js search improvement on mobile (#143) 2023-09-19 17:13:36 +02:00
tsconfig.json move js components to ts (#159) 2023-09-20 16:03:34 +02:00

OpenTofu OpenTofu

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
  1. Fetch the documentation:
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
  1. 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