Skip to content

Add GitLab UI-based Hugo theme

Sarah German requested to merge 4-hugo-theme into main

What does this MR do and why?

  • Updates frontend build tools to pull GitLab UI assets into the theme directory
  • Adds styling and and templates for our default page layout
  • Copies over some FE linting customizations we have on gitlab-docs

This should cover global elements that are not custom components (e.g, styling for headers and tables, but not tabs or menus). Custom components have individual issues for them later on in the project.

This MR should get the Hugo site looking mostly like our existing site, minus the fancier custom features.

Part 1 of 2 to close #4 (closed) (we'll customize codeblock styling and add the copy-to-clipboard feature in a separate MR)

Screenshots, screen recordings, or links to review app

These are pretty dramatic 😆

Before After
image image
image image

How to set up and validate locally

⚠ WARNING: Clone this project somewhere separate from your working copies of other gitlab projects (gitlab, gitlab-runner, etc), as it will remove existing copies that are in the same directory as gitlab-docs-hugo.

Numbered steps to set up and validate the change are strongly suggested.

  1. Check out this branch.
  2. Update dependencies: make setup
  3. Grab fresh content clones: REMOVE_BEFORE_CLONE=true make clone-docs-projects
  4. Run the dev site: make view

Merge request acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Edited by Sarah German

Merge request reports