1
0
mirror of synced 2025-12-19 18:10:59 -05:00
Files
docs/content/get-started/quickstart/setting-up-your-profile.md

5.7 KiB

title, shortTitle, intro, versions, topics, type
title shortTitle intro versions topics type
Setting up your profile Set up your profile Your profile tells people who you are and what you're interested in.
fpt ghes ghec
* * *
Profile
Accounts
how_to

About your profile

Your profile page on {% data variables.product.prodname_dotcom %} is a place where people can find out more about you. You can use your profile to:

  • Share your interests and skills.
  • Showcase your projects and contributions.
  • Express your identity{% ifversion fpt or ghec %} and show the {% data variables.product.prodname_dotcom %} community who you are{% endif %}.

In this tutorial, you'll learn the basics of how to personalize your profile by adding a profile picture, bio, and a profile README.

Prerequisites

  • You must have a {% data variables.product.prodname_dotcom %} account. {% ifversion fpt or ghec %}For more information, see "AUTOTITLE."{% endif %}

Adding a profile picture and bio

First, we'll add a picture to your profile. Your profile picture helps identify you across {% data variables.product.product_name %}.

Adding a profile picture

  1. In the upper-right corner of any page, click your existing profile avatar, then, from the dropdown menu, click Settings. {% data reusables.accounts.set-profile-picture %}

Next, we'll add some basic information about yourself to share with other {% data variables.product.product_name %} users. This information will display below your profile picture on your profile page.

Adding a bio

  1. On your profile page, under your profile picture, click Edit profile.

  2. Under "Bio", write one or two sentences about yourself, such as who you are and what you do.

    {% tip %}

    Tip: Keep the bio short; we'll add a longer description of your interests in your profile README in the section below.

    {% endtip %}

  3. To add an emoji to your bio, visit "Emoji cheat sheet" and copy and paste an emoji into the "Bio" dialog box.

  4. Optionally, add your {% ifversion profile-pronouns %}preferred pronouns,{% endif %} workplace, location and timezone{% ifversion profile-social-links %}, and any links to your personal website and social accounts{% endif %}. {% ifversion profile-pronouns %}{% data reusables.profile.pronouns-visibility %}{% endif %}

  5. Click Save.

Adding a profile README

In the "AUTOTITLE" tutorial, we learned how to create a new repository and how to add a README.md file to it. We'll do the same thing here, but this time, we'll create a special README file that displays on your profile page.

Your profile README lets you showcase information about yourself in more detail, such as your interests, skills, and background.

As we learned in the "Hello world" tutorial, README.md files are written using Markdown syntax, which is just a way to format plain text.

In the following steps, we'll create and edit your profile README.

Step 1: Create a new repository for your profile README

{% data reusables.profile.create-profile-readme %}

Step 2: Edit the README.md file

{% data reusables.profile.edit-profile-readme %}

  1. In the "Edit" view, you'll see some pre-populated text to get you started. On line 1, delete the text that says ### Hi there and type # About me.
    • In Markdown syntax, ### renders the plain text as a small ("third-level") heading, while ## or # renders a second- and first-level heading respectively.
  2. Toggle to "Preview" to see how the plain text now renders. You should see the new text displayed as a much larger heading.
  3. Toggle back to the "Edit" view.
  4. Delete line 3 and line 16.
    • This HTML syntax (e.g. <!--) is keeping the other lines hidden when you toggle to "Preview".
  5. Complete some of the prompts on lines 8 to 15, and delete any lines you don't want. For example, add your interests, skills, hobbies, or a fun fact about yourself.
  6. Now, toggle to "Preview". You should see your completed prompts render as a bulleted list.
  7. Toggle back to "Edit" and remove any other lines of text that you don't want displayed on your profile.
  8. Keep customizing and editing your profile README.

Step 3: Publish your changes to your profile

  1. When you're happy with how your profile README looks in "Preview", and you're ready to publish it, click Commit changes...
  2. In the open dialog box, simply click again Commit changes.
  3. Navigate back to your profile page. You will see your new profile README displayed on your profile.

Next steps

If you want to learn more Markdown syntax and add more sophisticated formatting to your profile README, see "AUTOTITLE."

Alternatively, try the {% data variables.product.prodname_learning %} "Communicate using Markdown" course.

Next, we'll look at ways you can explore {% data variables.product.product_name %} in "AUTOTITLE."

Further reading