generator-metalsmith-gitlab-pages

Yeoman generator for simple metalsmith static website (in typescript) for GitLab Pages.

Installation

First, install Yeoman and generator-metalsmith-gitlab-pages using npm (we assume you have pre-installed node.js).

npm install -g yo typescript
npm install -g generator-metalsmith-gitlab-pages

Then generate your new project:

yo metalsmith-gitlab-pages

Local Manual Build

You can build your website using make:

make build

The static website output is created in the public folder, which is used for GitLab Pages. Generally, you can customize your website by modifying the content files under the input folder and/or the layout files under the layouts folder. You can also update the src/index.ts file for further customization.

GitLab CI/CD

Navigate to your Project's Settings | CI/CD | Runners settings, and enable Shared Runners. (Note: It seems that Shared Runners are automatically enabled when you create a new project.)

Now, whenever you check in a change, the build will run, and your project website will be automatically updated.

Getting To Know Yeoman

• Yeoman has a heart of gold.
• Yeoman is a person with feelings and opinions, but is very easy to work with.
• Yeoman can be too opinionated at times but is easily convinced not to be.
• Feel free to learn more about Yeoman.

License

MIT © Harry