MkDocs

MkDocs

If you need an example source code, init a new project (you’ll need git, Python and pip):

# Use pip or pip3 depending on your system
pip install mkdocs 
mkdocs new myStaticApp

Create a static application

You can create an application in our Console or through Clever Tools:

npm i -g clever-tools
clever login

cd myStaticApp
clever create -t static-apache myStaticApp

To deploy on Clever Cloud, your local folder need to be a git reposiory (if not, git init) linked to an application. If you already have an application on Clever Cloud and want to link it to the current local folder:

clever link your_app_name_or_ID

Configure environment variables

Next, we configure the application with a medium build instance to quickly generate static files. The host instance is nano-sized, enough for a simple website. As Clever Cloud is based on standards, you only need to define a few variables:

clever scale --build-flavor M
clever scale --flavor nano

clever env set CC_WEBROOT "/site"
clever env set CC_OVERRIDE_BUILDCACHE "/site"
clever env set CC_PRE_BUILD_HOOK "python3 -m ensurepip --upgrade && pip3 install mkdocs"
clever env set CC_POST_BUILD_HOOK "mkdocs build"

Git push!

Once all these steps have been completed, commit your content to the local repository and deploy it:

git add .
git commit -m "First deploy"
clever deploy
clever open

You can display your website’s URL or add a custom domain to it (you’ll need to configure DNS):

clever domain
clever domain add your.website.tld
Last updated on

Did this documentation help you ?