Repository files navigation

This repository includes the source for the Moodle Developer Resources - acollection of resources aimed at making your life as a Moodle Developer easier.

These resources are written by developers, for developers. We value your inputand your help in adding to them.

There are many ways that you can help, from reporting inaccuracies, and missingdocumentation, to making small corrections and, of course, creating newresources for others to make use of.

If you plan to contribute, then you may wish to setup a local developmentenvironment to make it easier to do so.

We highly recommend that you read ourdocumentation contributions guide, which includes important information ongetting started.

For more information on the installation process see ourinstallation documentation, but if you want to jump right in then the easiest way is usingNVM and then running:

nvm installnpm i -g yarnyarnyarn start

During development you will almost certainly want to use the yarn development server, however you will sometimes need to build the content to use certainfeatures.

This is easily achieved with yarn:

yarn build

This command will compile all of the documentation into static HTML files complete with all appropriate resources.

As part of this build, the validity of all internal links will be checked. For this reason we strongly recommend building the content locally before submitting a pull request as broken internal links will lead to a build failureimmediately.

You may also need to configure the build to view it locally. This can be achieved using a.env file in the project root. For more information on the format of the.env file, see the documentation in the.env.default file.