Skip to content

Commit 4217d8e

Browse files
Update deploy-mkdocs.md
1 parent 9696be4 commit 4217d8e

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

β€Žrecipes/ci-cd/github-actions/workflows/mkdocs/deploy-mkdocs.mdβ€Ž

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
# Deploy MkDocs action
22

3-
- [deploy-mkdocs](https://github.com/marketplace/actions/deploy-mkdocs) action.
3+
{% raw %}
4+
5+
Marketplace:
46

5-
That action will install MkDocs and the Material theme and deploy to GH Pages for you. You don't need to specify or install any requirements.
7+
- [deploy-mkdocs](https://github.com/marketplace/actions/deploy-mkdocs) action.
68

7-
**Warning** - on the release of tag `1.15`, this action only deploys a configured `material` theme and fails on `mkdocs` or `readthedocs` as theme choices.
9+
This action will install MkDocs and the Material theme and deploy to GH Pages for you. You don't need to specify or install any requirements.
810

11+
**Warning:** on the release of tag `1.15`, this action only deploys a configured `material` theme and fails on `mkdocs` or `readthedocs` as theme choices.
912

1013
See the shell steps in [action.sh](https://github.com/mhausenblas/mkdocs-deploy-gh-pages/blob/master/action.sh) script.
1114

@@ -46,3 +49,6 @@ The `env` section also allows:
4649
```yaml
4750
CUSTOM_DOMAIN: optionaldomain.com
4851
```
52+
53+
{% endraw %}
54+

0 commit comments

Comments
Β (0)