Skip to content

Commit e7f802a

Browse files
author
gptkong
committed
add Readme
1 parent cc56ec8 commit e7f802a

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed

README.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Docker Documentation Build
2+
3+
This repository contains Dockerfiles and related resources for building and running documentation websites for various projects. Each subdirectory corresponds to a specific project and contains the necessary Dockerfile and other resources.
4+
5+
## Directory Structure
6+
7+
- `react-cn-docs/`
8+
- Contains the Dockerfile for building the React Chinese documentation site.
9+
- `react-flow/`
10+
- Contains the Dockerfile for building the React Flow documentation site.
11+
- `react-hook-form/`
12+
- Contains the Dockerfile for building the React Hook Form documentation site.
13+
- `shadcn-ui-docs/`
14+
- Contains the Dockerfile for building the ShadCN UI documentation site.
15+
- `tailwindcss-docs/`
16+
- Contains the Dockerfile for building the TailwindCSS documentation site.
17+
- `tanstack/`
18+
- Contains the Dockerfile for building the TanStack documentation site.
19+
20+
## Usage
21+
22+
Each directory contains a `Dockerfile` that can be used to build and run the corresponding documentation site. Below are the general steps to use the Dockerfiles:
23+
24+
1. Navigate to the directory of the project you want to build.
25+
2. Build the Docker image:
26+
```powershell
27+
docker build -t <image-name> .
28+
```
29+
3. Run the Docker container:
30+
```powershell
31+
docker run -p <host-port>:<container-port> <image-name>
32+
```
33+
34+
Replace `<image-name>`, `<host-port>`, and `<container-port>` with appropriate values.
35+
36+
## Example
37+
38+
To build and run the TailwindCSS documentation site:
39+
40+
```powershell
41+
cd tailwindcss-docs
42+
43+
docker build -t tailwindcss-docs .
44+
45+
docker run -p 3000:3000 tailwindcss-docs
46+
```
47+
48+
## Notes
49+
50+
- Ensure Docker is installed and running on your system.
51+
- Some projects may require additional dependencies or configurations. Refer to the respective `Dockerfile` for details.
52+
53+
## License
54+
55+
This repository is licensed under the MIT License. See the LICENSE file for more details.

0 commit comments

Comments
 (0)