Repository files navigation

Thedocumentation 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 theCONTRIBUTING or these detailedinstructions.

The project installs theHugo Relearn Theme as a git submodule. Thus when cloningthe repository, you need to use the--recurse-submodules parameter:

git clone --recurse-submodules git@github.com:contao/docs.git

or:

git clone --recurse-submodules https://github.com/contao/docs.git

Due to the switch of the theme from Hugo Learn to Hugo Relearn, you will need to execute

git submodule syncgit submodule update

once, if you had already checked out the repository before the switch.

To update the theme after cloning - or after the theme switch, run the following command:

git submodule foreach git pull origin main

The documentation is built using theHugo site generator,thus you need toinstall Hugofirst on your system.

Building is done using themake command. There are different commands availabledepending on what part of the documentation you want to build.

make build-devmake build-manual

Builds the entire documentation into thebuild directory.

make live-devmake live-manual

Spins up the development server which automatically tracks changes in thedocsdirectory and rebuilds the front end. You can access the front end onhttp://localhost:1313.

make clean

Cleans the build directory.

Your are not dependent on theMakefile. Ifmake is not availablein your operating system, you can still invoke the hugo commands. For example:

cd pagehugo server --cleanDestinationDir --environment manual --destination ../build/manual

Or for the Developer Documentation:

cd pagehugo server --cleanDestinationDir --environment dev --destination ../build/dev

The Contao documentation is licensed under aCreative Commons Attribution-NonCommercial-ShareAlike 4.0 InternationalLicense 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 yourcontent does not violate any third-party rights.

We are not claiming exclusive usage rights, therefore you are free to use yourcontributed content (e.g. texts or images) in any other project as well.