Customization¶
Escape if you are here to read / update a document.¶
The documentation template is based on mkdocs,you can find the full documentation of the theme here, theme customization
Here goes some of the important features.
Making the home page unavailable¶
if you need to make the home page temporary unavailable, you can simple uncomment from mkdocs.yml under
plugins:
- redirects:
redirect_maps:
index.md : temperary-unavailable.md
Host and build¶
the repo is on developers412 account on github according to the ci.yml configs once a push is made to the main branch an action to triggered to install the dependencies using pip over an ubuntu image then --force to gh-deploy branch.
The host is on netlify, linked to the github repo so that it's automatically triggers a deploy from the gh-deploy branch once it's updated.
Custom domain¶
at the moment the document is deployed on https://cities-os.netlify.app/ if you want to change the domain to be https://(here goes you custom name).netlify.app/ head to netlify dashboard
then click on the domain settings
under custom domains you can set your custom domain that is under netlify domain for free, or buy any other domain of your own.
Plugins¶
the them is rich with plugins that are easy to install, for instance pdf export