mdBook

mdBook is a command-line tool for creating modern online books and documentation. It is designed to help you write and organize your content in a structured way.

Requirements

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

cargo install mdbook
mdbook init myStaticApp --title="my mdBook" --ignore=git

Deploy a static application

You can create an application in our Console or through Clever Tools. Install them with npm or any supported package manager:

# Install with npm or any supported method
npm i -g clever-tools

# Login to Clever Cloud and check it worked
clever login
clever profile

Go to the folder where you want to create your application, and run the following command:

cd myStaticApp
clever create -t static

# If the folder is not a git repository, initialize it:
git init

To deploy on Clever Cloud, your local folder need to be an initialized git repository 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

Automatic build

mdBook is one of the many Static Site Generator (SSG) that Clever Cloud automatic build supports in the static runtime, you don’t have anything special to manage. To use a pico instance with a dedicated build instance change it in the Console or with Clever Tools:

clever scale --flavor pico

# To select a bigger build instance, use:
clever scale --build-flavor M

Push your code

Once you complete these steps, 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

404 page location

If you need to use a specific page for 404 errors, define its location with SERVER_ERROR_PAGE_404 environment variable from Static Web Server, used as default in static runtime. For example : SERVER_ERROR_PAGE_404=404.html.

🎓 Learn more