If you want to contribute, please follow this guideline.
- You need to install Node.js and Hugo.
- Fork this project.
- Clone your fork to your PC.
- Install dependencies, run command:
$ npm ci
- Create a new branch for your contributions
- Write your code. Some helping commands:
- Build page:
npm run build
. The built page will be/src/public/index.html
. - Run local Hugo server to monitor your changes in real-time as you write code:
npm run start-server
- Build page:
- Test your code with command
$ npm test
. It should pass, otherwise fix the errors. Some commands available for automatic fix of errors:- For ESLint (JS):
$ npm run lint:fix
- For Stylelint (CSS):
$ npm run stylelint:fix
- For Markdown:
$ npm run markdown:fix
- For ESLint (JS):
- Commit your changes and open PR.
- GitHub Guide: Contributing to projects. Learn how to contribute to a project through forking. Useful if you're not familiar with GitHub forking yet.
- Hugo manual