Documentation for Dead by Daylight modding. The master
branch is hosted on https://modbydaylight.com.
Contributions are welcomed and appreciated. All pull requests should target the dev
branch.
Before opening a pull request, it is recommended you test your changes locally to ensure there are no linking errors and everything displays as expected.
Requirements:
Instructions:
- Open a terminal window in the documentation root directory and run
npm run setup
to install necessary dependencies. If the installer complains about the installation directory not being included in the path, it may be necessary to add it. - Run
npm run serve
to launch a webserver at http://localhost:8000, which you can then connect to with a browser. The webserver will watch for changes to documentation files and automatically update and refresh your browser as you make changes. You may also runnpm run build
which will generate output HTML in thesite
directory.NOTE: If the theme is being modified, run
npm run serve:theme
to make the server also watch for changes to theme files. Additionally, because stylesheets are built from SCSS files, changes to files in thestyles
directory will not be automatically updated. Runningnpm run build
will automatically update them, or you can runnpx gulp buildstyles
to only update the CSS. - Run
npm run build-and-serve
and visit http://localhost:8000 to ensure your changes will display correctly once uploaded.