Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 38 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,49 @@ https\://bazel-docs-68tmf.ondigitalocean.app/

## Usage

Run the latest build locally:
Bash into the docker image to see the Hugo converted website:

```bash
docker run -it -p 1313:1313 alan707/bazel-docs:latest
docker run -it -p 1313:1313 alan707/bazel-docs:latest bash
```

Build a new image:
Once inside, the generated Hugo site will be at the following location:

```bash
docker build . -t bazel_docs:latest
root@7feab7b056d2:/app/docs# ls -al /app/docs
total 52
drwxr-xr-x 1 root root 4096 Jul 15 05:53 .
drwxr-xr-x 1 root root 4096 Jul 15 05:53 ..
-rw-r--r-- 1 root root 0 Jul 15 05:53 .hugo_build.lock
drwxr-xr-x 2 root root 4096 Jul 15 05:53 archetypes
drwxr-xr-x 3 root root 4096 Jul 15 05:53 assets
drwxr-xr-x 25 root root 4096 Jul 15 05:53 content
drwxr-xr-x 2 root root 4096 Jul 15 05:53 data
-rw-r--r-- 1 root root 99 Jul 15 05:53 go.mod
-rw-r--r-- 1 root root 394 Jul 15 05:53 go.sum
-rw-r--r-- 1 root root 2527 Jul 15 05:53 hugo.yaml
drwxr-xr-x 2 root root 4096 Jul 15 05:53 i18n
drwxr-xr-x 2 root root 4096 Jul 15 05:53 layouts
drwxr-xr-x 3 root root 4096 Jul 15 05:53 resources
drwxr-xr-x 12 root root 4096 Jul 15 05:53 static
```

To test your changes, you can convert the Bazel Docs Devsite into a Hugo website running this command
```bash
root@7feab7b056d2:/app# python /app/cli.py convert --source /app/work/bazel-source/site/en/ --output /app/docs/
```

Add the modules needed (mainly Docsy)
```bash
cd /app/docs
hugo mod init github.com/alan707/bazel-docs && \
hugo mod get github.com/google/docsy@v0.12.0 && \
hugo mod tidy
```

Generate static files and start the Hugo server
```bash
cd /app/docs
hugo --destination /workspace/public
hugo server --bind 0.0.0.0 --baseURL "http://localhost:1313"
```