# Tutorial on Chirpy

https://geekifan.github.io/chirpy-starter/categories/tutorial/ Recent content in Tutorial on Chirpy Hugo en Sun, 11 Aug 2019 00:34:00 +0800

# Customize the Favicon

https://geekifan.github.io/chirpy-starter/post/2019-08-11-customize-the-favicon/ Sun, 11 Aug 2019 00:34:00 +0800 https://geekifan.github.io/chirpy-starter/post/2019-08-11-customize-the-favicon/<p>The <a href="https://www.favicon-generator.org/about/">favicons</a> of <a href="https://github.com/cotes2020/jekyll-theme-chirpy/"><strong>Chirpy</strong></a> are placed in the directory <code class="filepath">assets/img/favicons/</code>. You may want to replace them with your own. The following sections will guide you to create and replace the default favicons.</p> <h2 id="generate-the-favicon" id=generate-the-favicon> <span class="me-2">Generate the favicon</span> <a href="#generate-the-favicon" class="anchor text-muted"><i class="fas fa-hashtag"></i></a> </h2><p>Prepare a square image (PNG, JPG, or SVG) with a size of 512x512 or more, and then go to the online tool <a href="https://realfavicongenerator.net/"><strong>Real Favicon Generator</strong></a> and click the button <kbd>Select your Favicon image</kbd> to upload your image file.</p>

# Getting Started

https://geekifan.github.io/chirpy-starter/post/2019-08-09-getting-started/ Fri, 09 Aug 2019 20:55:00 +0800 https://geekifan.github.io/chirpy-starter/post/2019-08-09-getting-started/<blockquote class="prompt-warning"><p><strong>NOTE:</strong> This tutorial is not fully migrated from the Jekyll version &ndash; please reference with caution.</p></blockquote> <h2 id="creating-a-site-repository" id=creating-a-site-repository> <span class="me-2">Creating a Site Repository</span> <a href="#creating-a-site-repository" class="anchor text-muted"><i class="fas fa-hashtag"></i></a> </h2><p>When creating your site repository, you have two options depending on your needs:</p> <h3 id="option-1-using-the-starter-recommended" id=option-1-using-the-starter-recommended> <span class="me-2">Option 1. Using the Starter (Recommended)</span> <a href="#option-1-using-the-starter-recommended" class="anchor text-muted"><i class="fas fa-hashtag"></i></a> </h3><p>This approach simplifies upgrades, isolates unnecessary files, and is perfect for users who want to focus on writing with minimal configuration.</p> <ol> <li>Sign in to GitHub and navigate to the <a href="https://github.com/geekifan/chirpy-starter"><strong>starter</strong></a>.</li> <li>Click the <kbd>Use this template</kbd> button and then select <kbd>Create a new repository</kbd>.</li> <li>Name the new repository <code>&lt;username&gt;.github.io</code>, replacing <code>username</code> with your lowercase GitHub username.</li> </ol> <h3 id="option-2-forking-the-theme" id=option-2-forking-the-theme> <span class="me-2">Option 2. Forking the Theme</span> <a href="#option-2-forking-the-theme" class="anchor text-muted"><i class="fas fa-hashtag"></i></a> </h3><p>This approach is convenient for modifying features or UI design, but presents challenges during upgrades. So don&rsquo;t try this unless you are familiar with Jekyll and plan to heavily modify this theme.</p>

# Writing a New Post

https://geekifan.github.io/chirpy-starter/post/2019-08-08-write-a-new-post/ Thu, 08 Aug 2019 14:10:00 +0800 https://geekifan.github.io/chirpy-starter/post/2019-08-08-write-a-new-post/<p>This tutorial will guide you how to write a post in the <em>Chirpy</em> template, and it&rsquo;s worth reading even if you&rsquo;ve used Hugo before, as many features require specific variables to be set.</p> <h2 id="naming-and-path" id=naming-and-path> <span class="me-2">Naming and Path</span> <a href="#naming-and-path" class="anchor text-muted"><i class="fas fa-hashtag"></i></a> </h2><p>Create a new file using <code>hugo new content/post/YYYY-MM-DD-TITLE.md</code>. You can change the path as you like, but note that all the posts should be placed in <code class="filepath">content/post</code> of the root directory.</p> <h2 id="front-matter" id=front-matter> <span class="me-2">Front Matter</span> <a href="#front-matter" class="anchor text-muted"><i class="fas fa-hashtag"></i></a> </h2><p>Basically, you need to fill the <a href="https://gohugo.io/content-management/front-matter/">Front Matter</a> as below at the top of the post:</p>