Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/gurusabarish/hugo-profile/llms.txt

Use this file to discover all available pages before exploring further.

All Hugo Profile customization lives in a single file — hugo.yaml (or hugo.toml) at the root of your site. Top-level keys control Hugo’s own build behavior, while the params block is where you configure every visual and functional aspect of your portfolio theme. This page covers every top-level setting and global params field; linked sub-pages go deeper on the navbar, color system, and typography.

​
Top-Level Settings

These keys sit at the root of hugo.yaml and configure the Hugo build itself.
KeyTypeDescription
baseURLstringCanonical base URL of your site, e.g. "https://example.com"
languageCodestringBCP 47 language tag, e.g. "en-us"
titlestringSite title — used in <title> tags and as the default navbar brand name
themestringMust be hugo-profile (or the path to your theme directory)
defaultContentLanguagestringDefault language code when multilingual is configured, e.g. "en"
enableRobotsTXTbooleanWhen true, Hugo generates a robots.txt file
pagination.pagerSizeintegerNumber of posts shown per blog list page; default: 10
outputs.homelistOutput formats for the home page — must include "JSON" to enable site search
markup.goldmark.renderer.unsafebooleanAllow raw HTML inside Markdown content; set true if you use HTML in .md files
The outputs.home list must contain "HTML", "RSS", and "JSON" for the built-in search feature to work. Omitting "JSON" disables search entirely.

​
Global params Fields

All fields below live under the top-level params: key.
​
params.title
string
Site title displayed in the navbar brand area. Falls back to the top-level title key if omitted.
​
params.description
string
Meta description injected into <meta name="description"> and used by the OpenGraph partial.
​
params.favicon
string
Site-relative path to the favicon image, e.g. "/fav.png". Also used as the default navbar brand logo when params.navbar.brandLogo is not set.
​
params.staticPath
string
Optional URL prefix prepended to all static asset paths (CSS, JS, Bootstrap). Use this to serve assets from a CDN or a different subdirectory. Leave unset or empty to serve assets locally.
​
params.useBootstrapCDN
boolean | string
Controls whether Bootstrap is loaded from jsDelivr CDN instead of locally.
  • false (default) — Bootstrap is served from your own static files
  • true — both Bootstrap CSS and JS are loaded from CDN
  • "css" — only Bootstrap CSS is loaded from CDN
  • "js" — only Bootstrap JS is loaded from CDN
​
params.cloudinary_cloud_name
string
Your Cloudinary cloud name. When set, the theme can construct dynamic responsive image URLs from Cloudinary. Your images must already be uploaded to the specified Cloudinary account.
​
params.mathjax
boolean
default:"false"
When true, MathJax is loaded on every page of the site. You can also enable it selectively per page by adding mathjax: true to that page’s frontmatter.
​
params.animate
boolean
default:"false"
Enables CSS fade animations on the home page. When true, the hero content fades in from the left, the navbar fades down from the top, and the hero image fades in. When omitted or set to false, all elements render immediately with no entrance transition.

​
Minimal Working Example

The following hugo.yaml is enough to get a site running with search enabled and sensible defaults: 
baseURL: "https://yoursite.example.com"
languageCode: "en-us"
title: "Your Name"
theme: hugo-profile

enableRobotsTXT: true

pagination:
  pagerSize: 3

outputs:
  home:
    - "HTML"
    - "RSS"
    - "JSON"

markup:
  goldmark:
    renderer:
      unsafe: true

params:
  title: "Your Name"
  description: "Personal portfolio and blog of Your Name."
  favicon: "/fav.png"

  useBootstrapCDN: false
  mathjax: false
  animate: true

​
Next Steps

Navbar

Configure brand logo, alignment, sticky behavior, search, and per-section menu visibility.

Color Theming

Customize light and dark mode colors using params.color and params.theme.

Fonts & Animation

Adjust base typography, line height, text alignment, and fade animation behavior.

Build docs developers (and LLMs) love

Get started for freeTalk to us