Textwire Documentation

Documentation website for Textwire templating language for Go (Golang) written with VitePress

Contribute

Build an Image

To build an image, navigate to the root of the project and run this command.

With Podman:

podman-compose build

With Docker:

docker compose build

Create node_modules

Run this command to install npm packages and generate a node_modules directory on your local machine.

With Podman:

podman-compose run --rm app npm i

With Docker:

docker compose run --rm app npm i

Run the Container

To run a container, navigate to the root of the project and run this command.

With Podman:

podman-compose up

With Docker:

docker compose up

You can visit localhost:3000 to see your documentation.

Enter the Container

To enter inside of the container, run this command.

With Podman:

podman-compose app sh

With Docker:

docker compose app sh

You'll be able to run NPM commands inside of the container.

Remove the Container

After you are done working on a project, you can cleanup by removing running containers.

With Podman:

podman-compose down

With Docker:

docker compose down

NPM Commands

Install Dependencies

npm i

Watch File Changes

npm run dev

Navigate to localhost:5173 to see your documentation if you run this project locally. With container engines it's going to be localhost:3000.