The documentation for the Contao project will be maintained in this repository.
The details below are only necessary if you want to install the docs locally. If you just want to contribute content, read the CONTRIBUTING.
The project installs the Hugo Learn theme as a git submodule. Thus when cloning
the repository, you need to use the
git clone --recurse-submodules firstname.lastname@example.org:contao/docs.git
git clone --recurse-submodules https://github.com/contao/docs.git
Updating the Theme
To update the theme after cloning, simply run the following command:
git submodule foreach git pull origin master
Building is done using the
make command. There are different commands available
depending on what part of the documentation you want to build.
make build-dev make build-manual
Builds the entire documentation into the
make live-dev make live-manual
Spins up the development server which automatically tracks changes in the
directory and rebuilds the front end. You can access the front end on http://localhost:1313.
Cleans the build directory.
Your are not dependent on the Makefile. If
make is not available
in your operating system, you can still invoke the hugo commands. For example:
cd page hugo server --cleanDestinationDir --environment manual --destination ../build/manual
The Contao documentation is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License license (CC BY-NC-SA 4.0). If you want to redistribute a modified or unmodified version of the documentation, you can do so under the license terms.
If you contribute to the documentation, e.g. by creating pull requests, you grant us full usage rights of any content you create or upload. You also ensure that your content does not violate any third-party rights.
We are not claiming exclusive usage rights, therefore you are free to use your contributed content (e.g. texts or images) in any other project as well.