{"id":20769,"date":"2020-08-05T06:22:11","date_gmt":"2020-08-05T13:22:11","guid":{"rendered":"https:\/\/careerkarma.com\/blog\/?p=20769"},"modified":"2020-12-29T12:33:54","modified_gmt":"2020-12-29T20:33:54","slug":"github-profile-readme","status":"publish","type":"post","link":"https:\/\/careerkarma.com\/blog\/github-profile-readme\/","title":{"rendered":"How to Create a Github Profile README Using Markdown"},"content":{"rendered":"\n<p>Github gives us the opportunity to personalize our profile \u2013 the page where our pinned repositories are \u2013 with a custom README.md that introduces who we are as developers. In this article, we take a look at steps to create a README file for your profile page and go over how to use Github-flavored Markdown to create the README.<br><\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Step 0: Create New Repository<\/h2>\n\n\n\n<p>To initialize your profile page with your markdown file, navigate to your repositories page and click on the green \u201cnew\u201d button in the upper right hand corner of your screen.<\/p>\n\n\n\n<figure class=\"wp-block-image\"><img loading=\"lazy\" decoding=\"async\" width=\"1000\" height=\"123\" src=\"https:\/\/careerkarma.com\/blog\/wp-content\/uploads\/2020\/08\/Screen-Shot-2020-08-01-at-8.44.37-PM.png\" alt=\"\" class=\"wp-image-20787\" srcset=\"https:\/\/careerkarma.com\/blog\/wp-content\/uploads\/2020\/08\/Screen-Shot-2020-08-01-at-8.44.37-PM.png 1000w, https:\/\/careerkarma.com\/blog\/wp-content\/uploads\/2020\/08\/Screen-Shot-2020-08-01-at-8.44.37-PM-768x94.png 768w, https:\/\/careerkarma.com\/blog\/wp-content\/uploads\/2020\/08\/Screen-Shot-2020-08-01-at-8.44.37-PM-770x95.png 770w, https:\/\/careerkarma.com\/blog\/wp-content\/uploads\/2020\/08\/Screen-Shot-2020-08-01-at-8.44.37-PM-385x47.png 385w, https:\/\/careerkarma.com\/blog\/wp-content\/uploads\/2020\/08\/Screen-Shot-2020-08-01-at-8.44.37-PM-20x2.png 20w\" sizes=\"auto, (max-width: 1000px) 100vw, 1000px\" \/><\/figure>\n\n\n\n<h2 class=\"wp-block-heading\">Step 1: Repository Settings<\/h2>\n\n\n\n<p>Fill out the \u201cRepository name\u201d field with your Github username. Your handle must match the \u201cOwner\u201d field just to the left of the repo name field. Click the checkbox that indicates you would like to initialize the repository with a README. Finally, click on \u201cCreate Repository\u201d.&nbsp;<br><\/p>\n\n\n\n<figure class=\"wp-block-image\"><img loading=\"lazy\" decoding=\"async\" width=\"1000\" height=\"244\" src=\"https:\/\/careerkarma.com\/blog\/wp-content\/uploads\/2020\/08\/Screen-Shot-2020-08-01-at-8.45.13-PM.png\" alt=\"\" class=\"wp-image-20786\" srcset=\"https:\/\/careerkarma.com\/blog\/wp-content\/uploads\/2020\/08\/Screen-Shot-2020-08-01-at-8.45.13-PM.png 1000w, https:\/\/careerkarma.com\/blog\/wp-content\/uploads\/2020\/08\/Screen-Shot-2020-08-01-at-8.45.13-PM-768x187.png 768w, https:\/\/careerkarma.com\/blog\/wp-content\/uploads\/2020\/08\/Screen-Shot-2020-08-01-at-8.45.13-PM-770x188.png 770w, https:\/\/careerkarma.com\/blog\/wp-content\/uploads\/2020\/08\/Screen-Shot-2020-08-01-at-8.45.13-PM-385x94.png 385w, https:\/\/careerkarma.com\/blog\/wp-content\/uploads\/2020\/08\/Screen-Shot-2020-08-01-at-8.45.13-PM-20x5.png 20w\" sizes=\"auto, (max-width: 1000px) 100vw, 1000px\" \/><\/figure>\n\n\n\n<p>Once the repository is created, you\u2019ll be taken to your personal repository where you will see a README.md that was committed to your repo with some default text. Click on the \u201cEdit\u201d icon in the upper right hand corner of the preview (it looks like a pencil) and you\u2019ll be taken to a page where you can flip between the actual markdown for your file and the preview of how it will look on your page.<\/p>\n\n\n\n<figure class=\"wp-block-image\"><img loading=\"lazy\" decoding=\"async\" width=\"1000\" height=\"636\" src=\"https:\/\/careerkarma.com\/blog\/wp-content\/uploads\/2020\/08\/Screen-Shot-2020-08-01-at-8.46.10-PM.png\" alt=\"\" class=\"wp-image-20788\" srcset=\"https:\/\/careerkarma.com\/blog\/wp-content\/uploads\/2020\/08\/Screen-Shot-2020-08-01-at-8.46.10-PM.png 1000w, https:\/\/careerkarma.com\/blog\/wp-content\/uploads\/2020\/08\/Screen-Shot-2020-08-01-at-8.46.10-PM-768x488.png 768w, https:\/\/careerkarma.com\/blog\/wp-content\/uploads\/2020\/08\/Screen-Shot-2020-08-01-at-8.46.10-PM-770x490.png 770w, https:\/\/careerkarma.com\/blog\/wp-content\/uploads\/2020\/08\/Screen-Shot-2020-08-01-at-8.46.10-PM-20x13.png 20w, https:\/\/careerkarma.com\/blog\/wp-content\/uploads\/2020\/08\/Screen-Shot-2020-08-01-at-8.46.10-PM-385x245.png 385w\" sizes=\"auto, (max-width: 1000px) 100vw, 1000px\" \/><\/figure>\n\n\n\n<h2 class=\"wp-block-heading\">Step 2: Editing Your README.md<\/h2>\n\n\n\n<p>For this step, you have a couple of options. If you are comfortable with working in an IDE, like Vim, Visual Studio Code, or Atom, you can clone and work on this file there. For the purpose of this article, we use Github\u2019s built-in text editor because we have the ability to preview the changes made before they are committed.&nbsp;<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Writing Markdown for Github<\/h3>\n\n\n\n<p>Github has its own Markdown dialect. Markdown helps create structured documents for email and discussion boards without having to use Hypertext Markup Language (HTML). Github\u2019s Markdown is known as the <a href=\"https:\/\/github.github.com\/gfm\/\" target=\"_blank\" rel=\"noopener\" rel=\"nofollow\">Github-Flavored Markdown<\/a> (GFM).&nbsp;<br><\/p>\n\n\n\n<p>The basic purpose of this version is to sanitize and process Markdown to ensure the security and consistency of Github\u2019s site. This means most of the Cascading Style Sheets (CSS) you use in traditional markdown may not be compatible with GFM. CSS is still available to us, but much of it is stripped away in the post-processing stage.&nbsp;<br><\/p>\n\n\n\n<p>As you construct the important components you want to display in your Github profile, keep in mind of what to do if the bio was a traditional HTML file and follow that convention as best as you can.<br><\/p>\n\n\n\n<p>Outside of these guidelines, your creativity and what you can come up with are what matter!&nbsp;<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Example<\/h3>\n\n\n\n<p>Here is an example using my Github profile:&nbsp;<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">Code:<\/h4>\n\n\n\n<div class=\"wp-block-codemirror-blocks-code-block code-block\"><pre>&lt;img src=&quot;https:\/\/images.unsplash.com\/photo-1444492417251-9c84a5fa18e0?ixlib=rb-1.2.1&amp;ixid=eyJhcHBfaWQiOjEyMDd9&amp;auto=format&amp;fit=crop&amp;w=975&amp;h=300&amp;q=80&quot;\/&gt;\n \n### Hi there \ud83d\udc4b, I'm Christina Kopecky. I'm a web developer and technical writer. Welcome to my gh page! &lt;br&gt;\n \nResume:  [Christina Kopecky Resume](https:\/\/resume.christinakopecky.com) (PDF download)\n \n\ud83d\udd2d *Currently working on*:  Articles that teach students and developers new-to-them technologies. Here are some examples of what I have been writing on: &lt;br&gt;\n&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp; [React Components: Class vs. Functional](https:\/\/careerkarma.com\/blog\/react-components\/)&lt;br&gt;\n&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp; [Web Fundamentals: JavaScript Scopes and Closure](https:\/\/careerkarma.com\/blog\/javascript-closure\/)&lt;br&gt;\n&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp; [CSS Flexbox](https:\/\/careerkarma.com\/blog\/css-flexbox\/)&lt;br&gt;\n&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp; [MongoDB vs PostgreSQL: what to consider when choosing a database](https:\/\/www.educative.io\/blog\/mongodb-versus-postgresql-databases)&lt;br&gt;\n \n\ud83c\udf31 *Currently Learning*: React-Native and Ruby&lt;br&gt;\n\ud83e\udd14 *Looking for help*: I'm looking for help with trying to find my first software engineering job in this current job climate.&lt;br&gt;\n\ud83d\udcac Ask me about: how to mentor students, creating a portfolio site for you, or assistance with an application you are working on. &lt;br&gt;\n\ud83d\udceb How to reach me: &lt;br&gt;\n&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp; [Email](christina@christinakopecky.com)\n&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp; [Twitter](https:\/\/www.twitter.com\/cmvnk)\n&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp; [LinkedIn](https:\/\/www.linkedin.com\/in\/cmvnk)\n \n\ud83d\ude04 Pronouns: She\/Her\/Hers &lt;br&gt;\n\u26a1 Fun facts:&lt;br&gt;\n&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp; :musical_note:  In my previous career I was a flutist and flute teacher. You can hear me play here: [Hypnosis by Ian Clarke](https:\/\/www.youtube.com\/watch?v=6MiZszJjBIQ)&lt;br&gt;\n&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp; :fallen_leaf: My favorite season is fall :smile: &lt;br&gt;\n \n \n&lt;!--\n**ckopecky\/ckopecky** is a \u2728 _special_ \u2728 repository because its `README.md` (this file) appears on your GitHub profile.\n \nHere are some ideas to get you started:\n \n- \ud83d\udd2d I'm currently working on ...\n- \ud83c\udf31 I'm currently learning ...\n- \ud83d\udc6f I'm looking to collaborate on ...\n- \ud83e\udd14 I'm looking for help with ...\n- \ud83d\udcac Ask me about ...\n- \ud83d\udceb How to reach me: ...\n- \ud83d\ude04 Pronouns: ...\n- \u26a1 Fun fact: ...\n--&gt;\n<\/pre><\/div>\n\n\n\n<h4 class=\"wp-block-heading\">How It Looks:<\/h4>\n\n\n\n<figure class=\"wp-block-image\"><img loading=\"lazy\" decoding=\"async\" width=\"1000\" height=\"881\" src=\"https:\/\/careerkarma.com\/blog\/wp-content\/uploads\/2020\/08\/Screen-Shot-2020-08-01-at-8.48.38-PM.png\" alt=\"\" class=\"wp-image-20789\" srcset=\"https:\/\/careerkarma.com\/blog\/wp-content\/uploads\/2020\/08\/Screen-Shot-2020-08-01-at-8.48.38-PM.png 1000w, https:\/\/careerkarma.com\/blog\/wp-content\/uploads\/2020\/08\/Screen-Shot-2020-08-01-at-8.48.38-PM-768x677.png 768w, https:\/\/careerkarma.com\/blog\/wp-content\/uploads\/2020\/08\/Screen-Shot-2020-08-01-at-8.48.38-PM-770x678.png 770w, https:\/\/careerkarma.com\/blog\/wp-content\/uploads\/2020\/08\/Screen-Shot-2020-08-01-at-8.48.38-PM-20x18.png 20w, https:\/\/careerkarma.com\/blog\/wp-content\/uploads\/2020\/08\/Screen-Shot-2020-08-01-at-8.48.38-PM-385x339.png 385w\" sizes=\"auto, (max-width: 1000px) 100vw, 1000px\" \/><\/figure>\n\n\n\n<p><\/p>\n\n\n\n<p>I completed this profile in about an hour after I realized the differences between Markdown and GFM. There are some little idiosyncrasies that I learned in the process, i.e: that CSS doesn\u2019t really work in GFM. One helpful resource library to me is the docs on <a href=\"https:\/\/docs.github.com\/en\/github\/writing-on-github\/basic-writing-and-formatting-syntax\" target=\"_blank\" rel=\"noopener\" rel=\"nofollow\">Github-Flavored Markdown<\/a>.&nbsp;<br><\/p>\n\n\n\n<p>Do not forget to commit your code! It automatically updates your profile page \u2013 the newly minted README is displayed above your pinned repositories. That\u2019s it! You\u2019ve just completed your very first iteration of your Github profile bio.<br><\/p>\n","protected":false},"excerpt":{"rendered":"Github gives us the opportunity to personalize our profile \u2013 the page where our pinned repositories are \u2013 with a custom README.md that introduces who we are as developers. In this article, we take a look at steps to create a README file for your profile page and go over how to use Github-flavored Markdown&hellip;","protected":false},"author":77,"featured_media":20785,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[17286],"tags":[],"class_list":{"0":"post-20769","1":"post","2":"type-post","3":"status-publish","4":"format-standard","5":"has-post-thumbnail","7":"category-git"},"acf":{"post_sub_title":"","sprint_id":"","query_class":"Git","school_sft":"","parent_sft":"","school_privacy_policy":"","has_review":null,"is_sponser_post":"","is_guest_post":""},"yoast_head":"<!-- This site is optimized with the Yoast SEO Premium plugin v27.4 (Yoast SEO v27.4) - https:\/\/yoast.com\/product\/yoast-seo-premium-wordpress\/ -->\n<title>How to Create a Github Profile README Using Markdown | Career Karma<\/title>\n<meta name=\"description\" content=\"Github recently rolled out the ability to create bios for your profile page. Learn how to create your own profile bio on Career Karma.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/careerkarma.com\/blog\/github-profile-readme\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"How to Create a Github Profile README Using Markdown\" \/>\n<meta property=\"og:description\" content=\"Github recently rolled out the ability to create bios for your profile page. Learn how to create your own profile bio on Career Karma.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/careerkarma.com\/blog\/github-profile-readme\/\" \/>\n<meta property=\"og:site_name\" content=\"Career Karma\" \/>\n<meta property=\"article:publisher\" content=\"http:\/\/facebook.com\/careerkarmaapp\" \/>\n<meta property=\"article:published_time\" content=\"2020-08-05T13:22:11+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2020-12-29T20:33:54+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/careerkarma.com\/blog\/wp-content\/uploads\/2020\/08\/photo-1590595906931-81f04f0ccebb.jpeg\" \/>\n\t<meta property=\"og:image:width\" content=\"1000\" \/>\n\t<meta property=\"og:image:height\" content=\"667\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/jpeg\" \/>\n<meta name=\"author\" content=\"Christina Kopecky\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@career_karma\" \/>\n<meta name=\"twitter:site\" content=\"@career_karma\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Christina Kopecky\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"5 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\\\/\\\/careerkarma.com\\\/blog\\\/github-profile-readme\\\/#article\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/careerkarma.com\\\/blog\\\/github-profile-readme\\\/\"},\"author\":{\"name\":\"Christina Kopecky\",\"@id\":\"https:\\\/\\\/careerkarma.com\\\/blog\\\/#\\\/schema\\\/person\\\/ae0cdc4a5d198690d78482646894074e\"},\"headline\":\"How to Create a Github Profile README Using Markdown\",\"datePublished\":\"2020-08-05T13:22:11+00:00\",\"dateModified\":\"2020-12-29T20:33:54+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\\\/\\\/careerkarma.com\\\/blog\\\/github-profile-readme\\\/\"},\"wordCount\":555,\"commentCount\":0,\"image\":{\"@id\":\"https:\\\/\\\/careerkarma.com\\\/blog\\\/github-profile-readme\\\/#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/careerkarma.com\\\/blog\\\/wp-content\\\/uploads\\\/2020\\\/08\\\/photo-1590595906931-81f04f0ccebb.jpeg\",\"articleSection\":[\"Git\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\\\/\\\/careerkarma.com\\\/blog\\\/github-profile-readme\\\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/careerkarma.com\\\/blog\\\/github-profile-readme\\\/\",\"url\":\"https:\\\/\\\/careerkarma.com\\\/blog\\\/github-profile-readme\\\/\",\"name\":\"How to Create a Github Profile README Using Markdown | Career Karma\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/careerkarma.com\\\/blog\\\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\\\/\\\/careerkarma.com\\\/blog\\\/github-profile-readme\\\/#primaryimage\"},\"image\":{\"@id\":\"https:\\\/\\\/careerkarma.com\\\/blog\\\/github-profile-readme\\\/#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/careerkarma.com\\\/blog\\\/wp-content\\\/uploads\\\/2020\\\/08\\\/photo-1590595906931-81f04f0ccebb.jpeg\",\"datePublished\":\"2020-08-05T13:22:11+00:00\",\"dateModified\":\"2020-12-29T20:33:54+00:00\",\"author\":{\"@id\":\"https:\\\/\\\/careerkarma.com\\\/blog\\\/#\\\/schema\\\/person\\\/ae0cdc4a5d198690d78482646894074e\"},\"description\":\"Github recently rolled out the ability to create bios for your profile page. Learn how to create your own profile bio on Career Karma.\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/careerkarma.com\\\/blog\\\/github-profile-readme\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/careerkarma.com\\\/blog\\\/github-profile-readme\\\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/careerkarma.com\\\/blog\\\/github-profile-readme\\\/#primaryimage\",\"url\":\"https:\\\/\\\/careerkarma.com\\\/blog\\\/wp-content\\\/uploads\\\/2020\\\/08\\\/photo-1590595906931-81f04f0ccebb.jpeg\",\"contentUrl\":\"https:\\\/\\\/careerkarma.com\\\/blog\\\/wp-content\\\/uploads\\\/2020\\\/08\\\/photo-1590595906931-81f04f0ccebb.jpeg\",\"width\":1000,\"height\":667},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/careerkarma.com\\\/blog\\\/github-profile-readme\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Blog\",\"item\":\"https:\\\/\\\/careerkarma.com\\\/blog\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Git\",\"item\":\"https:\\\/\\\/careerkarma.com\\\/blog\\\/git\\\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"How to Create a Github Profile README Using Markdown\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/careerkarma.com\\\/blog\\\/#website\",\"url\":\"https:\\\/\\\/careerkarma.com\\\/blog\\\/\",\"name\":\"Career Karma\",\"description\":\"Latest Coding Bootcamp News &amp; Career Hacks from Industry Insiders\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/careerkarma.com\\\/blog\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Person\",\"@id\":\"https:\\\/\\\/careerkarma.com\\\/blog\\\/#\\\/schema\\\/person\\\/ae0cdc4a5d198690d78482646894074e\",\"name\":\"Christina Kopecky\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/careerkarma.com\\\/blog\\\/wp-content\\\/uploads\\\/2020\\\/06\\\/image-3-150x150.jpg\",\"url\":\"https:\\\/\\\/careerkarma.com\\\/blog\\\/wp-content\\\/uploads\\\/2020\\\/06\\\/image-3-150x150.jpg\",\"contentUrl\":\"https:\\\/\\\/careerkarma.com\\\/blog\\\/wp-content\\\/uploads\\\/2020\\\/06\\\/image-3-150x150.jpg\",\"caption\":\"Christina Kopecky\"},\"description\":\"Christina is an experienced technical writer, covering topics as diverse as Java, SQL, Python, and web development. She earned her Master of Music in flute performance from the University of Kansas and a bachelor's degree in music with minors in French and mass communication from Southeast Missouri State. Prior to joining the Career Karma team in June 2020, Christina was a teaching assistant, team lead, and section lead at Lambda School, where she led student groups, performed code and project reviews, and debugged problems for students. Christina's technical content is featured frequently in publications like Codecademy, Repl.it, and Educative.\",\"sameAs\":[\"http:\\\/\\\/www.linkedin.com\\\/in\\\/cmvnk\"],\"url\":\"https:\\\/\\\/careerkarma.com\\\/blog\\\/author\\\/christina-kopecky\\\/\"}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"How to Create a Github Profile README Using Markdown | Career Karma","description":"Github recently rolled out the ability to create bios for your profile page. Learn how to create your own profile bio on Career Karma.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/careerkarma.com\/blog\/github-profile-readme\/","og_locale":"en_US","og_type":"article","og_title":"How to Create a Github Profile README Using Markdown","og_description":"Github recently rolled out the ability to create bios for your profile page. Learn how to create your own profile bio on Career Karma.","og_url":"https:\/\/careerkarma.com\/blog\/github-profile-readme\/","og_site_name":"Career Karma","article_publisher":"http:\/\/facebook.com\/careerkarmaapp","article_published_time":"2020-08-05T13:22:11+00:00","article_modified_time":"2020-12-29T20:33:54+00:00","og_image":[{"width":1000,"height":667,"url":"https:\/\/careerkarma.com\/blog\/wp-content\/uploads\/2020\/08\/photo-1590595906931-81f04f0ccebb.jpeg","type":"image\/jpeg"}],"author":"Christina Kopecky","twitter_card":"summary_large_image","twitter_creator":"@career_karma","twitter_site":"@career_karma","twitter_misc":{"Written by":"Christina Kopecky","Est. reading time":"5 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/careerkarma.com\/blog\/github-profile-readme\/#article","isPartOf":{"@id":"https:\/\/careerkarma.com\/blog\/github-profile-readme\/"},"author":{"name":"Christina Kopecky","@id":"https:\/\/careerkarma.com\/blog\/#\/schema\/person\/ae0cdc4a5d198690d78482646894074e"},"headline":"How to Create a Github Profile README Using Markdown","datePublished":"2020-08-05T13:22:11+00:00","dateModified":"2020-12-29T20:33:54+00:00","mainEntityOfPage":{"@id":"https:\/\/careerkarma.com\/blog\/github-profile-readme\/"},"wordCount":555,"commentCount":0,"image":{"@id":"https:\/\/careerkarma.com\/blog\/github-profile-readme\/#primaryimage"},"thumbnailUrl":"https:\/\/careerkarma.com\/blog\/wp-content\/uploads\/2020\/08\/photo-1590595906931-81f04f0ccebb.jpeg","articleSection":["Git"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/careerkarma.com\/blog\/github-profile-readme\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/careerkarma.com\/blog\/github-profile-readme\/","url":"https:\/\/careerkarma.com\/blog\/github-profile-readme\/","name":"How to Create a Github Profile README Using Markdown | Career Karma","isPartOf":{"@id":"https:\/\/careerkarma.com\/blog\/#website"},"primaryImageOfPage":{"@id":"https:\/\/careerkarma.com\/blog\/github-profile-readme\/#primaryimage"},"image":{"@id":"https:\/\/careerkarma.com\/blog\/github-profile-readme\/#primaryimage"},"thumbnailUrl":"https:\/\/careerkarma.com\/blog\/wp-content\/uploads\/2020\/08\/photo-1590595906931-81f04f0ccebb.jpeg","datePublished":"2020-08-05T13:22:11+00:00","dateModified":"2020-12-29T20:33:54+00:00","author":{"@id":"https:\/\/careerkarma.com\/blog\/#\/schema\/person\/ae0cdc4a5d198690d78482646894074e"},"description":"Github recently rolled out the ability to create bios for your profile page. Learn how to create your own profile bio on Career Karma.","breadcrumb":{"@id":"https:\/\/careerkarma.com\/blog\/github-profile-readme\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/careerkarma.com\/blog\/github-profile-readme\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/careerkarma.com\/blog\/github-profile-readme\/#primaryimage","url":"https:\/\/careerkarma.com\/blog\/wp-content\/uploads\/2020\/08\/photo-1590595906931-81f04f0ccebb.jpeg","contentUrl":"https:\/\/careerkarma.com\/blog\/wp-content\/uploads\/2020\/08\/photo-1590595906931-81f04f0ccebb.jpeg","width":1000,"height":667},{"@type":"BreadcrumbList","@id":"https:\/\/careerkarma.com\/blog\/github-profile-readme\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Blog","item":"https:\/\/careerkarma.com\/blog\/"},{"@type":"ListItem","position":2,"name":"Git","item":"https:\/\/careerkarma.com\/blog\/git\/"},{"@type":"ListItem","position":3,"name":"How to Create a Github Profile README Using Markdown"}]},{"@type":"WebSite","@id":"https:\/\/careerkarma.com\/blog\/#website","url":"https:\/\/careerkarma.com\/blog\/","name":"Career Karma","description":"Latest Coding Bootcamp News &amp; Career Hacks from Industry Insiders","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/careerkarma.com\/blog\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Person","@id":"https:\/\/careerkarma.com\/blog\/#\/schema\/person\/ae0cdc4a5d198690d78482646894074e","name":"Christina Kopecky","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/careerkarma.com\/blog\/wp-content\/uploads\/2020\/06\/image-3-150x150.jpg","url":"https:\/\/careerkarma.com\/blog\/wp-content\/uploads\/2020\/06\/image-3-150x150.jpg","contentUrl":"https:\/\/careerkarma.com\/blog\/wp-content\/uploads\/2020\/06\/image-3-150x150.jpg","caption":"Christina Kopecky"},"description":"Christina is an experienced technical writer, covering topics as diverse as Java, SQL, Python, and web development. She earned her Master of Music in flute performance from the University of Kansas and a bachelor's degree in music with minors in French and mass communication from Southeast Missouri State. Prior to joining the Career Karma team in June 2020, Christina was a teaching assistant, team lead, and section lead at Lambda School, where she led student groups, performed code and project reviews, and debugged problems for students. Christina's technical content is featured frequently in publications like Codecademy, Repl.it, and Educative.","sameAs":["http:\/\/www.linkedin.com\/in\/cmvnk"],"url":"https:\/\/careerkarma.com\/blog\/author\/christina-kopecky\/"}]}},"_links":{"self":[{"href":"https:\/\/careerkarma.com\/blog\/wp-json\/wp\/v2\/posts\/20769","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/careerkarma.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/careerkarma.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/careerkarma.com\/blog\/wp-json\/wp\/v2\/users\/77"}],"replies":[{"embeddable":true,"href":"https:\/\/careerkarma.com\/blog\/wp-json\/wp\/v2\/comments?post=20769"}],"version-history":[{"count":0,"href":"https:\/\/careerkarma.com\/blog\/wp-json\/wp\/v2\/posts\/20769\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/careerkarma.com\/blog\/wp-json\/wp\/v2\/media\/20785"}],"wp:attachment":[{"href":"https:\/\/careerkarma.com\/blog\/wp-json\/wp\/v2\/media?parent=20769"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/careerkarma.com\/blog\/wp-json\/wp\/v2\/categories?post=20769"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/careerkarma.com\/blog\/wp-json\/wp\/v2\/tags?post=20769"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}