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.

Hugo Profile can be installed in two ways: as a Git submodule or as a direct Git clone into your site’s themes/ directory. The submodule approach is recommended for most users — it keeps your site repository clean and lets you pull upstream theme updates with a single command. The clone approach is better suited to situations where you intend to modify the theme’s template files or layouts directly, since those changes won’t be overwritten by an update command.

​
Requirements

Before installing Hugo Profile, make sure you have the following:
  • Hugo 0.87.0 or higher — check your version with hugo version
  • Git — required to fetch the theme from GitHub
Hugo Profile requires Hugo 0.87.0 or higher. Run hugo version to confirm your installed version. If Hugo is not installed, follow the official installation guide for your operating system.

​
Install the Theme

First, create a new Hugo site if you haven’t already. Using --format="yaml" generates a hugo.yaml config file, which matches the format of Hugo Profile’s example configuration: 
hugo new site my-portfolio --format="yaml"
cd my-portfolio
Then install the theme using your preferred method:

​
Configure the Theme

Open hugo.yaml at the root of your site and set the theme key to hugo-profile: 
theme: hugo-profile
If you created your site with the hugo new site command, a minimal hugo.yaml already exists. You can either edit it manually or replace it entirely with the example configuration in the next step.

​
Copy the Example Configuration

Hugo Profile ships with a fully populated hugo.yaml that configures every section — Hero, About, Experience, Education, Projects, Achievements, Contact, navbar, footer, and more. Copy it to your site root to get started immediately: 
cp -f themes/hugo-profile/exampleSite/hugo.yaml ./hugo.yaml
This overwrites the minimal config Hugo generated. You can then open hugo.yaml and replace the placeholder content with your own details.

​
Verify the Installation

Start the Hugo development server to confirm everything is wired up correctly: 
hugo server
Open http://localhost:1313 in your browser. If the theme is installed and configured correctly, you’ll see the Hugo Profile example site. If Hugo reports errors in the terminal, double-check that:
  • The theme: hugo-profile line is present in hugo.yaml
  • The theme directory exists at themes/hugo-profile/
  • Your Hugo version is 0.87.0 or higher (hugo version)

​
Copy Example Content and Assets

On first run, images may be missing and the Blog or Gallery sections may not appear. Hugo expects static files in the root static/ folder and content pages in the root content/ folder, but the example files live inside the theme’s exampleSite/ directory. Copy them across with: 
rsync -av themes/hugo-profile/exampleSite/static/ ./static/
rsync -av themes/hugo-profile/exampleSite/content/ ./content/
Refresh your browser after running these commands — the complete site will render with all sections and images.

​
Updating the Theme

​
Submodule installations

To pull the latest theme version: 
git submodule update --remote themes/hugo-profile
Commit the updated submodule reference to your repository afterward: 
git add themes/hugo-profile
git commit -m "Update hugo-profile theme"

​
Clone installations

Navigate into the theme directory and pull the latest changes: 
cd themes/hugo-profile
git pull
cd ../..
Review any changes to the theme files before pulling if you have made local modifications, as upstream changes may conflict with your edits.

Build docs developers (and LLMs) love

Get started for freeTalk to us