Faust Website

This repository contains the source of the Faust website which is currently deployed at https://faust.grame.fr.

Prerequisites

• you must have python and pip installed.

Building the web site

The build process is based on make. Building the documentation site is based on mkdocs. To install the required components, type:

$ make install

To generate the web site, type:

$ make build

You'll find the web site in the ./site folder.

Testing and generating

You can test the web site using the mkdoc embedded web server. This server also scan any change in the source directory and refresh the pages dynamically which is really convenient for the development process. To launch the server type:

$ make serve

More details about the build process. Type:

$ make help

Publishing

Publishing is handled by GitHub Actions. Pushing to the main branch will build and deploy the site.

WARNING!!

• never delete the mkdocs/docs/CNAME file (which is mandatory for the final generated site to work)