A Guide to Creating Stunning GitHub Pages

A sample for creating content that boosts the visual appeal.

Posted Sep 9, 2023 Updated Dec 27, 2024

Illustration of documentation workflow

By Starlight

views 28 min read

A Guide to Creating Stunning GitHub Pages

This post serves the purpose of demonstrating how Markdown syntax is rendered on Chirpy. It can also be utilized as an illustrative example for crafting content to enhance the aesthetics of our GitHub Pages website. This includes creating beautifully designed documentation, blog posts, and more, with an emphasis on writing in-depth and comprehensive pieces.

Markdown

Markdown is a lightweight markup language that is used for formatting and structuring plain text documents.

It is often used for creating documents that will be converted to HTML, but it can also be used for other purposes such as documentation, README files, blogging and note-taking.

Headings

H1 — heading

H2 — heading

H3 — heading

H4 — heading

Paragraph

Detective Sarah Mitchell stood in the dimly lit room, her keen eyes scanning the scene for any trace of evidence. The air was thick with tension as she surveyed the opulent but now macabre setting of the crime. The victim, a prominent art collector named Victor Sinclair, lay sprawled on the Persian rug, his lifeless eyes fixed on an eerie painting that adorned the wall. A single gunshot had silenced him forever. Sarah’s mind raced as she considered the suspects gathered in the adjacent room, each with a motive that seemed as dark as the night outside. The clock was ticking, and she knew that solving this murder would require unraveling secrets buried deep in the world of high society and the art underworld. With a sense of determination, she vowed to uncover the truth, no matter how many layers of deception she had to peel back.

Lists

Ordered list

Item 1
Item 2
Item 3

Unordered list

Chapter 1
- Section 1.1
  - Paragraph 1.1.1
  - Paragraph 1.1.2
- Section 1.2
  - Paragraph 1.2.1

ToDo list

Job
- Step 1
- Step 2
- Step 3

Description list

Smartphone: A mobile device that combines a phone with various features such as internet access, camera, and apps.
Eiffel Tower: A famous Parisian landmark and wrought-iron structure, designed by Gustave Eiffel, and completed in 1889.

Emphasis

This is an italic text.

This is a bold text.

Tool-tip

Most inline HTML tags are supported.

  
Most inline <abbr title="Hypertext Markup Language">HTML</abbr> tags are supported.

Improving Visibility/Readability

Sometimes, Markdown content requires adding HTML elements and CSS attributes like color and font sizes, and weight attributes. However, Natively Markdown or any Markdown parser/flavor does not support CSS styles. There are multiple ways to achieve this:

Using HTML and CSS: Hello World!

  
<span style="color:green;font-weight:400;font-size:20px"> Hello World! </span>

Using Kramdown - a Ruby-based Markdown parser that extends the functionality of standard Markdown: This is green

This is *green*{: style="color: green"}

Using Emojis: When you want to use pure Markdown (without nested HTML & CSS), you can use Emojis to draw attention to some fragment of the file, i.e. ⚠️WARNING⚠️, 🔴DANGER🔴 or 🔥NEW🔥.

Enhanced Text Selection

Try selecting the text to see how it works:

The wind whispered through the trees as Emily walked along the cobblestone path, her footsteps muffled by the crunch of fallen leaves. The sun dipped low on the horizon, casting a warm glow over the landscape. In the distance, a solitary figure stood by the old oak tree, its branches heavy with secrets of days gone by. She couldn’t make out who it was, but something about the silhouette tugged at her heart, stirring memories she had long buried. As she approached, a shiver of anticipation ran down her spine—maybe it was a sign, a chance to unravel the past she had so carefully concealed.

It works well on most browsers, but may not function as intended on mobile devices. Additionally, nested elements within a paragraph can cause issues with enhanced selection.

Typography

Typography plays a crucial role in design, influencing readability, tone, and visual impact. It’s more than just choosing a typeface; it’s about crafting a visual experience that enhances communication and resonates with the audience. Effective typography guides the reader’s eye, sets the mood of the content, and reinforces the brand’s identity.

Hitmarker Text: Hitmarker Text is ideal for small-scale and long-copy text, offering excellent readability and a refined appearance for detailed content.

1. Hitmarker Text Light

  
<p style="font-family:'Hitmarker Text'; font-weight:300; font-size:24px;">1. Hitmarker Text Light</p>

2. Hitmarker Text Regular

  
<p style="font-family:'Hitmarker Text'; font-weight:400; font-size:24px;">2. Hitmarker Text Regular</p>

3. Hitmarker Text Medium

  
<p style="font-family:'Hitmarker Text'; font-weight:500; font-size:24px;">3. Hitmarker Text Medium</p>

4. Hitmarker Text Bold

  
<p style="font-family:'Hitmarker Text'; font-weight:700; font-size:24px;">4. Hitmarker Text Bold</p>

5. Hitmarker Text Black

  
<p style="font-family:'Hitmarker Text'; font-weight:900; font-size:24px;">5. Hitmarker Text Black</p>

6. Hitmarker Text Regular with proper style.

  
<p style="font-family:'Hitmarker Text'; font-weight:400; font-style: normal; letter-spacing: 1px; font-size: 1rem; line-height: 1.5rem;">6. Hitmarker Text Regular with proper style.</p>

6.1 Hitmarker Text Regular with proper style.

  
<p style="font-family:'Hitmarker Text'; font-weight:400; font-style: normal; color: white; letter-spacing: 1px; font-size: 1rem; line-height: 1.5rem;">6.1 Hitmarker Text Regular with proper style.</p>

Hitmarker Condensed: Hitmarker Condensed is perfect for headlines (headings), display text, and other large typographic elements, providing a bold and condensed look that ensures strong visual impact.

1. Hitmarker Condensed Light

  
<p style="font-family:'Hitmarker Condensed'; font-weight:300; font-size:24px;">1. Hitmarker Condensed Light</p>

2. Hitmarker Condensed Regular

  
<p style="font-family:'Hitmarker Condensed'; font-weight:400; font-size:24px;">2. Hitmarker Condensed Regular</p>

3. Hitmarker Condensed Medium

  
<p style="font-family:'Hitmarker Condensed'; font-weight:500; font-size:24px;">3. Hitmarker Condensed Medium</p>

4. Hitmarker Condensed Bold

  
<p style="font-family:'Hitmarker Condensed'; font-weight:700; font-size:24px;">4. Hitmarker Condensed Bold</p>

5. Hitmarker Condensed Black

  
<p style="font-family:'Hitmarker Condensed'; font-weight:900; font-size:24px;">5. Hitmarker Condensed Black</p>

6. Hitmarker Condensed Black with proper style.

  
<p style="font-family:'Hitmarker Condensed'; font-weight:900; font-style: normal; font-size: 1.75rem; text-transform: uppercase; letter-spacing: 1px; line-height: 1.75rem;">6. Hitmarker Condensed Black with proper style.</p>

6.1 Hitmarker Condensed Black with proper style.

  
<p style="font-family:'Hitmarker Condensed'; font-weight:900; font-style: normal; font-size: 1.75rem; text-transform: uppercase; letter-spacing: 1px; line-height: 1.75rem; color: white;">6.1 Hitmarker Condensed Black with proper style.</p>

6.2 Hitmarker Condensed Black with proper style.

  
<p style="font-family:'Hitmarker Condensed'; font-weight:900; font-style: normal; font-size: 2.25rem; text-transform: uppercase; letter-spacing: 1px; line-height: 2.25rem;">6.2 Hitmarker Condensed Black with proper style.</p>

For further exploration and details on these fonts, visit the following resources:

Call of Duty - Typography ↗
NaN - Custom Call of Duty Fonts ↗
Global Fonts - Hitmarker ↗

In addition to Hitmarker, there are several other popular fonts that are widely used in programming and design. These fonts offer distinct styles and features that cater to various needs, whether you’re coding, creating technical documents, or designing modern interfaces. Below are some notable fonts to consider for your projects:

Font	Description	Link
`Fira Code`	A monospaced font designed for coding, with support for programming ligatures.	Fira Code ↗
`Cascadia Mono`	A modern monospaced font from Microsoft, often used in command-line interfaces and code editors.	Cascadia Code ↗
`JetBrains Mono`	A monospaced typeface for developers, designed by JetBrains, featuring increased letter-spacing for readability.	JetBrains Mono ↗
`Orbitron`	A geometric sans-serif typeface, ideal for futuristic and sci-fi projects, often used in headlines and display text.	Orbitron ↗
`Hitmarker`	A custom typeface associated with the Call of Duty brand, versatile for body text and headlines in regular and condensed versions.	Hitmarker ↗

Block Quote

Single-line

To be or not to be, that is the question.

Multi-line

To be, or not to be, that is the question: Whether ‘tis nobler in the mind to suffer The slings and arrows of outrageous fortune, Or to take arms against a sea of troubles And, by opposing, end them.

_{— William Shakespeare’s play “Hamlet”}

Collapsible Content

Click to toggle content

Who Was Mr. Chips?

Mr. Chipping, affectionately known as "Mr. Chips", was a beloved English teacher at the fictional boarding school of Brookfield. He had spent over fifty years at the school, shaping the minds of countless students with his gentle, humorous, and old-fashioned manner. Known for his characteristic tweed jacket and thick glasses, he became a fixture of the school's traditions, loved by generations of boys.

Throughout his long tenure, Mr. Chips led a quiet, unassuming life, until one day he fell in love with a young woman named Katherine Bridges. She was the daughter of one of the school's former headmasters, and their brief but poignant romance changed him in ways he never anticipated. Tragically, Katherine passed away not long after their engagement, and Mr. Chips never married. Yet, her memory remained a deep part of his heart, influencing the way he viewed life and his students.

Click to toggle content

Time dilation is a concept from Einstein's theory of relativity, where time passes at different rates for observers in different conditions. There are two main types:

Gravitational Time Dilation: Time runs slower in stronger gravitational fields. For example, a clock on the surface of the Earth ticks slower than one far from Earth.
Velocity Time Dilation: Time runs slower for objects moving at speeds close to the speed of light. For example, a clock on a spaceship traveling near light speed would tick slower than one on Earth. $$ \text{Time Dilation: } \Delta t' = \frac{\Delta t}{\sqrt{1 - \frac{v^2}{c^2}}} $$

Prompts

An example showing the tip type prompt.

An example showing the info type prompt.

An example showing the warning type prompt.

An example showing the danger type prompt.

Tip

This is a tip.

Info

This is an info.

Warning

This is a warning.

Danger

This is a danger.

Tip: Keep your software up to date for better performance.

Info: Make sure to back up your files regularly to avoid data loss.

Warning: High temperatures can damage your device. Keep it cool.

Danger: Do not touch electrical wires while they are live.

This is a tip.

This is a note.

This is an important note.

This is a warning.

This is a caution.

Tables

Company	Contact	Country
ABC Electronics	John Smith	USA
Global Imports	Emily Johnson	Canada
La Maison du Vin	Pierre Dupont	France

File(s)	In Directory	from %TEMP%
`*.PNG`	✓	✗
`*.ICO`	✓	✗

✓ means keep, ✗ means delete.

Embed Files

To embed files in your blog, you can use <iframe> elements like this:

  
<iframe src="file path" width="100%" height="800"></iframe>

This approach allows you to preview HTML, PDF, and other documents directly within your post.

Note

While this method works well in Google Chrome, other browsers may not fully support it. Additionally, adding overflow won’t generate scroll bars on mobile devices, so use this technique with caution.

Links

Starlight

  
[Starlight](https://github.com/tis-starlight){: target="_blank" rel="noopener noreferrer"}

// rel="noopener noreferrer" means that the link is set to 
// open in a new tab (target="_blank") 
// while taking precautions to improve security by restricting access 
// to the originating page and not sending the Referer header. 
// This is commonly used with links that involve external websites.

Starlight

  
[**Starlight**][link]

[link]: https://github.com/tis-starlight

Footnote

Click the hook will locate the footnote¹, and here is another footnote².

Keyboard Input

Press Ctrl+Alt+Delete to restart the computer.

Press Shift+D to duplicate objects in blender.

Inline code

This is an example of Inline Code.

Filepath

Here is the /path/to/the/file.extension.

Code blocks

Common

This is a common code snippet, without syntax highlight and line number.

Specific Language

  
#include <iostream>
int main() {
    // Display a simple message
    std::cout << "Hello, World!" << std::endl;
    return 0;
}

Specific filename

  
@import
  "colors/light-typography",
  "colors/dark-typography";

Mathematics

The mathematics powered by MathJax :

A cubic Bezier curve is often used for smooth paths or animations. The equation is:

\[\begin{equation} B(t) = (1 - t)^3 \cdot P_0 + 3(1 - t)^2 \cdot t \cdot P_1 + 3(1 - t) \cdot t^2 \cdot P_2 + t^3 \cdot P_3 \label{eq:bezier_curve} \end{equation}\] \[\text{where } P_0, P_1, P_2, \text{ and } P_3 \text{ are control points and } t \text{ ranges from } 0 \text{ to } 1.\]

We can reference the equation as \eqref{eq:bezier_curve}.

When $a \ne 0$, there are two solutions to $ax^2 + bx + c = 0$ and they are

\[x = {-b \pm \sqrt{b^2-4ac} \over 2a}\]

Mermaid SVG

gantt
  title  Adding GANTT diagram
  C :a, 2022-04-12, 1w
  CSharp :crit, b, 2022-04-12, 10d
  C++ :active, c, after b a, 10d

flowchart LR
  A[Hard] -->|Text| B(Round)
  B --> C{Decision}
  C -->|One| D[Result 1]
  C -->|Two| E[Result 2]

classDiagram
Class01 <|-- AveryLongClass : Cool
<<Interface>> Class01
Class09 --> C2 : Where am I?
Class09 --* C3
Class09 --|> Class07
Class07 : equals()
Class07 : Object[] elementData
Class01 : size()
Class01 : int chimp
Class01 : int gorilla
class Class10 {
  <<service>>
  int id
  size()
}

Images

Default (with caption)

Full screen width and center alignment

Left aligned

Float to left

In the heart of this desolate no man’s land, the very essence of nature seemed to have withered away, leaving behind a haunting, barren expanse. The landscape, once vibrant with life, had succumbed to the relentless forces of time and neglect. A relentless wind whispered through skeletal remains of long-forgotten trees, their twisted branches reaching towards a colorless sky. The ground beneath was cracked and parched, resembling a shattered mosaic of forgotten dreams. The earth, choked by an endless sea of gray dust, bore the scars of a world that had turned its back on it. Here, no creature stirred, and no songbird dared to sing. The silence was profound, as if the land itself held its breath, waiting for some long-lost spark of vitality to ignite its soul.

Float to right

In the heart of a desolate, colorless gray field, there stands a lone tree, its gnarled branches reaching out like skeletal fingers towards the overcast sky. The land stretches out in all directions, barren and lifeless, devoid of any signs of habitation or growth. The silence here is oppressive, broken only by the occasional whisper of the wind as it mournfully dances through the withered grass. In this desolation, one can’t help but feel utterly alone, a solitary figure in a world drained of vibrancy and vitality, where even time itself seems to have come to a standstill.

Dark/Light mode & Shadow

The image below will toggle dark/light mode based on theme preference, notice it has shadows.

Naming and Path

Create a new file named YYYY-MM-DD-TITLE.EXTENSION and put it in the _posts of the root directory. Please note that the EXTENSION must be one of md and markdown. If you want to save time of creating files, please consider using the plugin Jekyll-Compose to accomplish this.

Front Matter

Basically, you need to fill the Front Matter as below at the top of the post:

  
---
title: TITLE
date: YYYY-MM-DD HH:MM:SS +/-TTTT
categories: [TOP_CATEGORY, SUB_CATEGORY]
tags: [TAG]     # TAG names should always be lowercase
---

The posts’ layout has been set to post by default, so there is no need to add the variable layout in the Front Matter block.

Timezone of Date

To accurately record the release date of a post, you should not only set up the timezone of _config.yml but also provide the post’s timezone in variable date of its Front Matter block. Format: +/-TTTT, e.g. +0500.

Categories and Tags

The categories of each post are designed to contain up to two elements, and the number of elements in tags can be zero to infinity. For instance:

  
---
categories: [Animal, Insect]
tags: [bee]
---

Author Information

The author information of the post usually does not need to be filled in the Front Matter , they will be obtained from variables social.name and the first entry of social.links of the configuration file by default. But you can also override it as follows:

Adding author information in _data/authors.yml (If your website doesn’t have this file, don’t hesitate to create one).

  
<author_id>:
  name: <full name>
  twitter: <twitter_of_author>
  url: <homepage_of_author>

And then use author to specify a single entry or authors to specify multiple entries:

  
---
author: <author_id>                     # for single entry
# or
authors: [<author1_id>, <author2_id>]   # for multiple entries
---

Having said that, the key author can also identify multiple entries.

The benefit of reading the author information from the file _data/authors.yml is that the page will have the meta tag twitter:creator, which enriches the Twitter Cards and is good for SEO.

Post Description

By default, the first words of the post are used to display on the home page for a list of posts, in the Further Reading section, and in the XML of the RSS feed. If you don’t want to display the auto-generated description for the post, you can customize it using the description field in the Front Matter as follows:

  
---
description: Short summary of the post.
---

Additionally, the description text will also be displayed under the post title on the post’s page.

By default, the Table of Contents (TOC) is displayed on the right panel of the post. If you want to turn it off globally, go to _config.yml and set the value of variable toc to false. If you want to turn off TOC for a specific post, add the following to the post’s Front Matter :

  
---
toc: false
---

Comments

The global setting for comments is defined by the comments.provider option in the _config.yml file. Once a comment system is selected for this variable, comments will be enabled for all posts.

If you want to close the comment for a specific post, add the following to the Front Matter of the post:

  
---
comments: false
---

Media

Images, Audio and Video are refered to as media resource.

URL Prefix

From time to time we have to define duplicate URL prefixes for multiple resources in a post, which is a boring task that you can avoid by setting two parameters.

If you are using a CDN to host media files, you can specify the cdn in _config.yml. The URLs of media resources for site avatar and posts are then prefixed with the CDN domain name.
1 cdn: https://cdn.com
To specify the resource path prefix for the current post/page range, set media_subpath in the front matter of the post:
1 2 3 --- media_subpath: /path/to/media/ ---

The option site.cdn and page.media_subpath can be used individually or in combination to flexibly compose the final resource URL: [site.cdn/][page.media_subpath/]file.ext

Images

Caption

Add italics to the next line of an image, then it will become the caption and appear at the bottom of the image:

  
![img-description](/path/to/image)
_Image Caption_

Size

To prevent the page content layout from shifting when the image is loaded, we should set the width and height for each image.

  
![Desktop View](/assets/img/sample/mockup.png){: width="700" height="400" }

For an SVG, you have to at least specify its width, otherwise it won’t be rendered.

Starting from Chirpy v5.0.0, height and width support abbreviations (height → h, width → w). The following example has the same effect as the above:

  
![Desktop View](/assets/img/sample/mockup.png){: w="700" h="400" }

Position

By default, the image is centered, but you can specify the position by using one of the classes normal, left, and right.

Once the position is specified, the image caption should not be added.

Normal position

Image will be left aligned in below sample:

  
![Desktop View](/assets/img/sample/mockup.png){: .normal }

Float to the left

  
![Desktop View](/assets/img/sample/mockup.png){: .left }

Float to the right

  
![Desktop View](/assets/img/sample/mockup.png){: .right }

Dark/Light mode

You can make images follow theme preferences in dark/light mode. This requires you to prepare two images, one for dark mode and one for light mode, and then assign them a specific class (dark or light):

  
![Light mode only](/path/to/light-mode.png){: .light }
![Dark mode only](/path/to/dark-mode.png){: .dark }

Shadow

The screenshots of the program window can be considered to show the shadow effect:

  
![Desktop View](/assets/img/sample/mockup.png){: .shadow }

Preview Image

If you want to add an image at the top of the post, please provide an image with a resolution of 1200 x 630. Please note that if the image aspect ratio does not meet 1.91 : 1, the image will be scaled and cropped.

Knowing these prerequisites, you can start setting the image’s attribute:

  
---
image:
  path: /path/to/image
  alt: image alternative text
---

Note that the media_subpath can also be passed to the preview image, that is, when it has been set, the attribute path only needs the image file name.

For simple use, you can also just use image to define the path.

  
---
image: /path/to/image
---

LQIP

Low Quality Image Placeholder: A technique displaying a small, highly compressed, low-resolution image initially to users while the high-quality image loads in the background. It is lightweight and give the impression of faster website loading. As the high-quality image loads, it gradually replaces the LQIP for a seamless transition.

For preview images:

  
---
image:
  lqip: /path/to/lqip-file # or base64 URI
---

You can observe LQIP in the preview image of this post .

For normal images:

  
![Image description](/path/to/image){: lqip="/path/to/lqip-file" }

Video

You can embed videos from social media platforms with the following syntax:

  
{% include embed/{Platform}.html id='{ID}' %}

Where Platform is the lowercase of the platform name, and ID is the video ID.

The following table shows how to get the two parameters we need in a given video URL, and you can also know the currently supported video platforms.

Video URL	Platform	ID
https://www.youtube.com/watch?v=mrNX55CWuZA	`youtube`	`mrNX55CWuZA`
https://www.twitch.tv/videos/2221198216	`twitch`	`2221198216`

Video Files

If you want to embed a video file directly, use the following syntax:

  
{% include embed/video.html src='{URL}' %}

Where URL is a URL to a video file e.g. /path/to/sample/video.mp4.

You can also specify additional attributes for the embedded video file. Here is a full list of attributes allowed.

poster='/path/to/poster.png' — poster image for a video that is shown while video is downloading
title='Text' — title for a video that appears below the video and looks same as for images
autoplay=true — video automatically begins to play back as soon as it can
loop=true — automatically seek back to the start upon reaching the end of the video
muted=true — audio will be initially silenced
types — specify the extensions of additional video formats separated by |. Ensure these files exist in the same directory as your primary video file.

Consider an example using all of the above:

  
{%
  include embed/video.html
  src='/path/to/video.mp4'
  types='ogg|mov'
  poster='poster.png'
  title='Demo video'
  autoplay=true
  loop=true
  muted=true
%}

Audios

If you want to embed an audio file directly, use the following syntax:

  
{% include embed/audio.html src='{URL}' %}

Where URL is a URL to an audio file e.g. /path/to/audio.mp3.

You can also specify additional attributes for the embedded audio file. Here is a full list of attributes allowed.

title='Text' — title for an audio that appears below the audio and looks same as for images
types — specify the extensions of additional audio formats separated by |. Ensure these files exist in the same directory as your primary audio file.

Consider an example using all of the above:

  
{%
  include embed/audio.html
  src='/path/to/audio.mp3'
  types='ogg|wav|aac'
  title='Demo audio'
%}

Pinned Posts

You can pin one or more posts to the top of the home page, and the fixed posts are sorted in reverse order according to their release date. Enable by:

  
---
pin: true
---

Prompts

There are several types of prompts: tip, info, warning, and danger. They can be generated by adding the class prompt-{type} to the blockquote. For example, define a prompt of type info as follows:

> Example line for prompt.
{: .prompt-info }

Syntax

Inline Code

`inline code part`

Filepath Hightlight

`/path/to/a/file.extension`{: .filepath}

Code Block

Markdown symbols ``` can easily create a code block as follows:

  
```
This is a plaintext code snippet.
```

Specifying Language

Using ```{language} you will get a code block with syntax highlight:

  
```yaml
key: value
```

The Jekyll tag {% highlight %} is not compatible with this theme.

Line Number

By default, all languages except plaintext, console, and terminal will display line numbers. When you want to hide the line number of a code block, add the class nolineno to it:

  
```shell
echo 'No more line numbers!'
```
{: .nolineno }

Specifying the Filename

You may have noticed that the code language will be displayed at the top of the code block. If you want to replace it with the file name, you can add the attribute file to achieve this:

  
```shell
# content
```
{: file="path/to/file" }

Liquid Codes

If you want to display the Liquid snippet, surround the liquid code with {% raw %} and {% endraw %}:

  
{% raw %}
```liquid
{% if product.title contains 'Pack' %}
  This product's title contains the word Pack.
{% endif %}
```
{% endraw %}

Or adding render_with_liquid: false (Requires Jekyll 4.0 or higher) to the post’s YAML block.

Mathematics

We use MathJax to generate mathematics. For website performance reasons, the mathematical feature won’t be loaded by default. But it can be enabled by:

  
---
math: true
---

After enabling the mathematical feature, you can add math equations with the following syntax:

Block math should be added with $$ math $$ with mandatory blank lines before and after $$
- Inserting equation numbering should be added with $$\begin{equation} math \end{equation}$$
- Referencing equation numbering should be done with \label{eq:label_name} in the equation block and \eqref{eq:label_name} inline with text (see example below)
Inline math (in lines) should be added with $$ math $$ without any blank line before or after $$
Inline math (in lists) should be added with \$$ math $$

  
<!-- Block math, keep all blank lines -->

$$
LaTeX_math_expression
$$

<!-- Equation numbering, keep all blank lines  -->

$$
\begin{equation}
  LaTeX_math_expression
  \label{eq:label_name}
\end{equation}
$$

Can be referenced as \eqref{eq:label_name}.

<!-- Inline math in lines, NO blank lines -->

"Lorem ipsum dolor sit amet, $$ LaTeX_math_expression $$ consectetur adipiscing elit."

<!-- Inline math in lists, escape the first `$` -->

1. \$$ LaTeX_math_expression $$
2. \$$ LaTeX_math_expression $$
3. \$$ LaTeX_math_expression $$

Starting with v7.0.0, configuration options for MathJax have been moved to file assets/js/data/mathjax.js, and you can change the options as needed, such as adding extensions.
If you are building the site via chirpy-starter, copy that file from the gem installation directory (check with command bundle info --path jekyll-theme-chirpy) to the same directory in your repository.

  
<style>
.MathJax { font-size: 1.3em !important; }
</style>

Mermaid

Mermaid is a great diagrams generation tool. To enable it on your post, add the following to the YAML block:

  
---
mermaid: true
---

Then you can use it like other markdown languages: surround the graph code with ```mermaid and ```.

Setting up the Environment

Once your repository is created, it’s time to set up your development environment. There are two primary methods:

1. Setting up Natively

Install Git
Install Ruby
- Add Environment Variable (Advanced System Settings>Environment Variables>System Variables): Variable Name = ruby Value = C:\Path\to\Ruby\bin
- rubygem is installed. (If you use rubyinstaller , ignore this step)
- If you had VS Code open when Ruby was installed and configured, please restart VS Code to ensure it recognizes the new configuration and updates to your system’s PATH.

These steps must be followed in order to avoid errors such as bundle: command not found

Clone your repository to your local machine.
If you forked the theme, install Node.js and run bash tools/init.sh in the root directory to initialize the repository. If you used the chirpy-starter template, you can skip this step.
Before running the local server for the first time, go to the root directory of your site and run bundle to install the dependencies.

$ bundle

2. Using Dev Containers

Dev Containers offer an isolated environment using Docker, which prevents conflicts with your system and ensures all dependencies are managed within the container.

Install Docker:
- On Windows/macOS, install Docker Desktop.
- On Linux, install Docker Engine.
Install VS Code and the Dev Containers extension.
Clone your repository:
- For Docker Desktop: Start VS Code and clone your repo in a container volume.
- For Docker Engine: Clone your repo locally, then open it in a container via VS Code.
Wait for the Dev Containers setup to complete.

Running Local Server

You may want to preview the site contents before publishing, so just run it by:

  
$ bundle exec jekyll serve

If you are using Dev Containers, you must run that command in the VS Code Terminal.

Pass the --livereload option to serve to automatically refresh the page with each change you make to the source files: bundle exec jekyll serve --livereload

After a few seconds, the local service will be published at http://127.0.0.1:4000.

Press Ctrl+C to stop the server.

Installing & Updating Chirpy

For installation, visit the Getting Started .
For updating chirpy, visit the Upgrade Guide .

Learn More

If you want to enhance your knowledge of Markdown, visit the Markdown .
If you’re interested in the Chirpy theme, you can check out the Chirpy .
For more knowledge about Jekyll, visit the Jekyll .
To learn about HTML tags, explore the HTML .
For information on CSS properties, refer to the CSS .
Master the art of responsive web design with Bootstrap .
For resizing, compressing, and converting images, you can use the Simple Image Resizer .
To convert images to base64 encoding, visit Code Beauty .
For GitHub shields, visit Shields.io .
For emojis, check out the Emoji Cheatsheet .
For a Markdown editor, explore MarkText .
For an all-in-one (AIO) editor, delve into VS Code .
For a workflow-based editor, consider Visual Studio .
To enhance your Markdown experience in Visual Studio Code, install the Markdown AIO .
For enhanced Markdown preview capabilities in VS Code, try the Markdown Preview Enhanced .
For image hosting, visit Imgur .
For high-quality, royalty-free CC0 images, visit Unsplash .
To add complex math equations in documentation, visit MathJax .
To add various diagrams, visit Mermaid .

These are not the only valuable resources available; there is a wealth of amazing work, content, and more to be found on the internet. Feel free to search for additional sources to deepen your knowledge.

Reverse Footnote

The footnote source ↩︎
The 2nd footnote source ↩︎

Programming Languages, Markdown

markdown cheatsheet

This post is licensed under CC BY 4.0 by the author.

Markdown

Headings

H1 — heading

H2 — heading

H3 — heading

H4 — heading

Paragraph

Lists

Ordered list

Unordered list

ToDo list

Description list

Emphasis

Tool-tip

Improving Visibility/Readability

Enhanced Text Selection

Typography

Block Quote

Single-line

Multi-line

Collapsible Content

Prompts

Tables

Embed Files

Links

Footnote

Keyboard Input

Inline code

Filepath

Code blocks

Common

Specific Language

Specific filename

Mathematics

Mermaid SVG

Images

Default (with caption)

Left aligned

Float to left

Float to right

Dark/Light mode & Shadow

Naming and Path

Front Matter

Timezone of Date

Categories and Tags

Author Information

Post Description

Table of Contents

Comments

Media

URL Prefix

Images

Caption

Size

Position

Dark/Light mode

Shadow

Preview Image

LQIP

Video

Social Media Platform

Video Files

Audios

Pinned Posts

Prompts

Syntax

Inline Code

Filepath Hightlight

Code Block

Specifying Language

Line Number

Specifying the Filename

Liquid Codes

Mathematics

Mermaid

Setting up the Environment

1. Setting up Natively

2. Using Dev Containers

Running Local Server

Installing & Updating Chirpy