From f4d28bc230b7c0bc99a82d2f2a873d5d348b9740 Mon Sep 17 00:00:00 2001 From: vktrrdk Date: Thu, 24 Jun 2021 14:32:47 +0200 Subject: [PATCH] feat(Config): Added documentation on custom site url --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index c8cca1f..c5463bb 100644 --- a/README.md +++ b/README.md @@ -40,3 +40,10 @@ where * config is a folder with the **hooks.json** file. 2. (Optional) You can change the theme in the config yaml. + +You can use the SITE_URL environment variable to set a specific URL if you want to override the default of the mkdocs configuration. +To do this, specify another variable in the command above: + +~~~BASH + -e SITE_URL=SITE_URL +~~~