- Hugo documentation
- Base theme - Ananke
- Hugo docker images
- Hugo Internal Templates
- Hugo themes
- Tachyons documentation
- Tachyons color codes for base theme
- Blogpost - Image processing using hugo
- Blogpost - Multilingual
- Go text template
- Article Add Contact form to Hugo with Google forms
- Add-ons for Hugo - Extend Hugo’s functionality
-
Create a New Issue
Describe the problem or task, add relevant links, and suggest potential solutions. Use templates to standardize the process. -
Create a Merge Request
Once the issue is created, open a Merge Request. Make sure to:- Mark it as draft if necessary.
- Enable delete source branch after merging. GitLab will create new branch automatically.
-
Work on the Merge Request
After making your changes, request a review. When ready, mark the Merge Request as ready for merging. -
Merge and Delete the Branch
Once the review is complete and approved, merge the changes and delete the branch.
Directory tree:
rc-content/
├── .github/
│ └── workflows/
│ └── hugo.yml
├── archetypes/
│ └── default.md
├── assets/
├── content/
├── config/ <-- site configuration
│ └── _default/
│ │ └── hugo.toml
│ └── production/
│ └── hugo.toml
├── data/
├── static/
├── .gitmodules
├── go.mod
├── docker-compose.yml
└── README.md
Website is deploying automatically by CI from main branch to
GitLab Stage Deploy.
For final deployment, make sure to push changes (ONLY content, theme will be getting from GitLab) from the
GitLab repository to the GitHub repository at rc-content.
The website will be automatically deployed from the main branch of the GitHub repository.
For local deploy use command docker-compose up (the site will be available at http://localhost:1313).
Alternatively, after downloading Hugo, you can run hugo server (the site will be available at http://localhost:1313).
If you want to make some changes in theme and to see the changes in real time, make sure to have theme in
next folder - themes.
To use a different theme, place it in the themes folder and update the hugo.toml configuration file to reflect
the new theme name.
To change the version of the theme, modify the go.mod file. Locate the line starting with
require gitlab.com/rework-space.com/rs-site/rs-theme and update it to the desired tag or commit SHA, such as
v0.0.0-20240806155827-02956aea1959.
- Add new
.mdfiles the appropriate paths, one for each language (with the next post number):
content/en/blog/post-1.md
content/ua/blog/post-1.md
- Post metadata
---
title: Post Title
url: '/blog/2023-03-24-post-title'
type: article
omit_header_text: false
featured_image: '/folder/image-name.jpg'
summary_image: '/folder/image-name-short.png'
sharing_image: '/folder/image-name-share.jpg'
twitter_sharing_image: '/folder/image-name-twitter-share.jpg'
alt: 'Picture for Post Title'
keywords: ['some', 'keywords']
blogs: ['some', 'tags']
date: 2023-03-24
draft: true
not_translate: true
---
title- post title on banner image.url- url address for new post must contain post date and post title. For ukraine language use prefix/ua/and the same url as for English ('/ua/blog/2023-03-24-post-title').type- shoud be "article" for blog post, but if your page is not translated use "page".omit_header_text- there could be two header types, use "false" for big header and "true" for small.featured_image- background banner image, must be in/static/folder. If parameter isn't present will be used default site image from home page.summary_image- image for post list (Blog page), must be in/assets/folder.sharing_image- to share post in LinkedIn and Facebook, the image must be rectangular. You could use the same image as summary_image from/assets/folder or specify a separate image and place it in/static/folder.twitter_sharing_image- to share post in Twitter, the image must be square. You can reuse an image from/assets/folder or specify a separate image and place it in/static/folder.alt- for banner image.keywords- for SEO improvements. It will be added to head metadata.blogs- tags for filtering blogs on page.date- post published date, it is using to sort posts on Blog page.draft- if "true" post won't be published (and won't be visible even on local deploy).not_translate- if "true" post won't be displayed on blog page.
Each markdown file that represent separate site page must have appropriation in each site language, otherwise language button won't be presented in Menu. If some page isn't translated to other language, please for empty markdown files use below text as page content.
For English
Unfortunately, the page is not translated into this language.
For Ukrainian
На жаль, сторінка не перекладена на цю мову.
Images could be stored in two places: /static/ or /assets/ folders.
- use
/assets/folder for images which will be presented in pagemainsection (images will be rendered by build); - use
/static/folder for background images specified in CSS code{ background: url(""); }(banner and header images) and for images which will be used for sharing but not presented on the site anywhere (such images won't be rendered by build);
To add an image between two text paragraphs inside markdown file use shortcode img:
{{< img src="/blog-images/post-1/image-name.png" alt="Figure 1. Image alt" css_class="img-scale-down">}}
Image must be in /assets/ folder, alt will be used as figcaption.
css_class - not required; possible options:
.img-width-contain {
object-fit: contain;
width: 100%;
}
.img-height-cover {
object-fit: cover;
height: 100%;
}
.img-scale-down {
object-fit: scale-down;
}
To add text in specific color. Without parameter color="" will be used base site color.
{{< color-text text="Section title in specific color" color="#FF0000">}}
To add link in base site color. It target="_blank" link will open in new tab. Without parameter target="" link will
open in the same tab (_self)
{{< color-link link_title="Link will be opened in new tab" path="https://gohugo.io/" target="_blank" >}}