Skip to content

Commit

Permalink
Trailing escape slash in code blocks appears broken
Browse files Browse the repository at this point in the history
  • Loading branch information
Mpdreamz committed Nov 21, 2024
1 parent 8fb3ede commit 32636df
Showing 1 changed file with 3 additions and 6 deletions.
9 changes: 3 additions & 6 deletions docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,7 @@ And we'll invest time in making sure these are easily obtainable (`brew`, `winge
For now you can run the tool locally through `docker run`

```bash
docker run -v "./.git:/app/.git" -v "./docs:/app/docs" -v "./.artifacts:/app/.artifacts" \
ghcr.io/elastic/docs-builder:edge
docker run -v "./.git:/app/.git" -v "./docs:/app/docs" -v "./.artifacts:/app/.artifacts" ghcr.io/elastic/docs-builder:edge
```

This ensures `.git`/`docs` and `.artifacts` (the default output directory) are mounted.
Expand All @@ -54,17 +53,15 @@ Only the changed files on subsequent runs will be compiled unless you pass `--fo
to force a new compilation.

```bash
docker run -v "./.git:/app/.git" -v "./docs:/app/docs" -v "./.artifacts:/app/.artifacts" \
ghcr.io/elastic/docs-builder:edge --force
docker run -v "./.git:/app/.git" -v "./docs:/app/docs" -v "./.artifacts:/app/.artifacts" ghcr.io/elastic/docs-builder:edge --force
```

#### Live mode

Through the `serve` command you can continuously and partially compile your documentation.

```bash
docker run -v "./.git:/app/.git" -v "./docs:/app/docs" -v "./.artifacts:/app/.artifacts" \
--expose 8080 ghcr.io/elastic/docs-builder:edge serve
docker run -v "./.git:/app/.git" -v "./docs:/app/docs" -v "./.artifacts:/app/.artifacts" --expose 8080 ghcr.io/elastic/docs-builder:edge serve
```

Each page is compiled on demand as you browse http://localhost:8080 and is never cached so changes to files and
Expand Down

0 comments on commit 32636df

Please sign in to comment.