Skip to main content

Overview

The profile section of your configuration defines your personal information displayed at the top of your SSH Portfolio. This includes your name, professional title, custom ASCII art, and an introduction message.

Configuration Fields

Profile information is configured at the root level of your config.yaml file.
name
string
required
Your full name as it should appear in the portfolio.Example:
name: "Abdul Sattar"
title
string
required
Your professional title or role.Example:
title: "Sr. Full-stack Developer"
ascii_art
string
Custom ASCII art displayed in your portfolio header. Use the pipe | character for multi-line strings in YAML.Example:
ascii_art: |
  ███████╗ █████╗ ████████╗████████╗ █████╗ ██████╗
  ██╔════╝██╔══██╗╚══██╔══╝╚══██╔══╝██╔══██╗██╔══██╗
  ███████╗███████║   ██║      ██║   ███████║██████╔╝
  ╚════██║██╔══██║   ██║      ██║   ██╔══██║██╔══██╗
  ███████║██║  ██║   ██║      ██║   ██║  ██║██║  ██║
  ╚══════╝╚═╝  ╚═╝   ╚═╝      ╚═╝   ╚═╝  ╚═╝╚═╝  ╚═╝
You can use online ASCII art generators to create custom text art for your name or brand.
intro
string
required
Your introduction text. This is displayed prominently and should give visitors a quick overview of who you are. Supports multiple lines using the pipe | character.Example:
intro: |
  Hi, I am Abdul Sattar!
  Passionate full-stack developer with over 
  5 years of practical experience developing 
  desktop, web, and mobile apps.

  Navigate with arrow keys and explore my projects.

Complete Example

Here’s a complete profile configuration from a real config.yaml:
name: "Abdul Sattar"
title: "Sr. Full-stack Developer"
ascii_art: |
  ███████╗ █████╗ ████████╗████████╗ █████╗ ██████╗
  ██╔════╝██╔══██╗╚══██╔══╝╚══██╔══╝██╔══██╗██╔══██╗
  ███████╗███████║   ██║      ██║   ███████║██████╔╝
  ╚════██║██╔══██║   ██║      ██║   ██╔══██║██╔══██╗
  ███████║██║  ██║   ██║      ██║   ██║  ██║██║  ██║
  ╚══════╝╚═╝  ╚═╝   ╚═╝      ╚═╝   ╚═╝  ╚═╝╚═╝  ╚═╝
intro: |
  Hi, I am Abdul Sattar!
  Passionate full-stack developer with over 
  5 years of practical experience developing 
  desktop, web, and mobile apps.

  Navigate with arrow keys and explore my projects.

Best Practices for Introduction Text

Keep It Concise

Your intro should be brief but impactful. Aim for 2-4 lines that capture your essence as a professional. Good:
intro: |
  Full-stack engineer specializing in scalable web applications.
  Passionate about clean code and user experience.
Too verbose:
intro: |
  I am a software engineer who has been coding for many years.
  I have worked on various projects including web development,
  mobile development, desktop applications, and much more.
  I love learning new technologies and frameworks...

Highlight Your Unique Value

What makes you different? Lead with your strongest skills or most interesting work.
intro: |
  Building developer tools at scale.
  Former startup founder, now helping teams ship faster.

Include a Call to Action

Guide visitors on how to navigate your portfolio.
intro: |
  Backend engineer with a focus on distributed systems.
  
  Use arrow keys to explore my work or jump to contact.

Use Proper Line Breaks

YAML preserves line breaks when using the | character, so format your text for readability.
intro: |
  DevOps engineer passionate about automation.
  
  Check out my projects below!

ASCII Art Resources

Tools for creating ASCII art for your portfolio:
Choose ASCII art fonts that are readable in terminal environments. Test your ASCII art in your SSH client before deploying.

Source Code Reference

The profile fields are defined in the Config struct in config/config.go:9-17:
type Config struct {
    Name     string          `yaml:"name"`
    Title    string          `yaml:"title"`
    ASCIIArt string          `yaml:"ascii_art"`
    Intro    string          `yaml:"intro"`
    Skills   []SkillCategory `yaml:"skills"`
    Projects []Project       `yaml:"projects"`
    Contact  Contact         `yaml:"contact"`
}

Build docs developers (and LLMs) love