Mirrors/zola
2
0
Fork 0
mirror of https://github.com/getzola/zola synced 2024-11-10 06:14:19 +00:00
Code Issues Projects Releases Packages Wiki Activity

Fix docs

Browse source 
Closes #2117
This commit is contained in:
Vincent Prouillet 2023-02-26 20:01:03 +01:00
parent e42283e916
commit 1a6c1a32be
2 changed files with 6 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/content/documentation/content/shortcodes.md
View file

@ -4,8 +4,7 @@ weight = 40
+++
Zola borrows the concept of [shortcodes](https://codex.wordpress.org/Shortcode_API) from WordPress.
In our case, a shortcode corresponds to a template defined in the `templates/shortcodes` directory or
a built-in one that can be used in a Markdown file.
In our case, a shortcode corresponds to a template defined in the `templates/shortcodes` directory that can be used in a Markdown file.
Broadly speaking, Zola's shortcodes cover two distinct use cases:

10
docs/content/documentation/getting-started/installation.md
View file

@ -127,7 +127,7 @@ jobs:
steps:
- uses: taiki-e/install-action@v2
with:
tool: zola@0.16
tool: zola@0.17.1
# ...
```
@ -139,26 +139,26 @@ Zola is available on [the GitHub registry](https://github.com/getzola/zola/pkgs/
It has no `latest` tag, you will need to specify a [specific version to pull](https://github.com/getzola/zola/pkgs/container/zola/versions).
```sh
$ docker pull ghcr.io/getzola/zola:v0.16.0
$ docker pull ghcr.io/getzola/zola:v0.17.1
```
#### Build
```sh
$ docker run -u "$(id -u):$(id -g)" -v $PWD:/app --workdir /app ghcr.io/getzola/zola:v0.16.0 build
$ docker run -u "$(id -u):$(id -g)" -v $PWD:/app --workdir /app ghcr.io/getzola/zola:v0.17.1 build
```
#### Serve
```sh
$ docker run -u "$(id -u):$(id -g)" -v $PWD:/app --workdir /app -p 8080:8080 ghcr.io/getzola/zola:v0.16.0 serve --interface 0.0.0.0 --port 8080 --base-url localhost
$ docker run -u "$(id -u):$(id -g)" -v $PWD:/app --workdir /app -p 8080:8080 ghcr.io/getzola/zola:v0.17.1 serve --interface 0.0.0.0 --port 8080 --base-url localhost
```
You can now browse http://localhost:8080.
> To enable live browser reload, you may have to bind to port 1024. Zola searches for an open
> port between 1024 and 9000 for live reload. The new docker command would be
> `$ docker run -u "$(id -u):$(id -g)" -v $PWD:/app --workdir /app -p 8080:8080 -p 1024:1024 ghcr.io/getzola/zola:v0.16.0 serve --interface 0.0.0.0 --port 8080 --base-url localhost`
> `$ docker run -u "$(id -u):$(id -g)" -v $PWD:/app --workdir /app -p 8080:8080 -p 1024:1024 ghcr.io/getzola/zola:v0.17.1 serve --interface 0.0.0.0 --port 8080 --base-url localhost`
## Windows