diff --git a/README.md b/README.md index 8552eb023..6ae680971 100644 --- a/README.md +++ b/README.md @@ -124,3 +124,13 @@ git clone https://github.com/mailcow/mailcow-dockerized-docs.git pip install -r requirements.txt mkdocs serve ``` + + +The Placeholder values get replaced by the javascript in the file docs/assets/javascript/client.js. + +If you want to test how the documentation looks like with the placeholder values filled in, you can set the values via url parameters. + +For Example: +``` +http://127.0.0.1:8000/client/client-manual/#host=mail.test.org&email=mail@example.org&name=mail&ui=mail.example.org&port=443 +``` \ No newline at end of file