Skip to main content

Writing a New Post

· 2 min read
Guangze Yang
Guangze Yang
Master of Control System, Ibaraki University

Reference: Writing a New Post

YAML Frontmatter​

---
title: TITLE
date: YYYY-MM-DD HH:MM:SS +0900 #Tokyo
categories: [TOP_CATEGORIE, SUB_CATEGORIE]
tags: [TAG1, TAG2]  
author: <author_id>
math: true #Mathematical
img_path: img/path/
---

Math Support​

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

$$
LaTeX_math_expression
$$

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

$$

  LaTeX_math_expression
  \label{eq:label_name}

$$

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 $$

Mermaid Diagrams​

---
mermaid: true
---

Images​

Caption​

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

Size Control​

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

Image Path Configuration​

---
img_path: img/path/
---

CDN URL Setup​

# _config.yml
img_cdn: https://cdn.com

Preview Image​

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

Pinned Posts​

---
pin: true
---

Prompt Boxes​

Available prompt types in Jekyll Chirpy: tip, info, warning, danger

tip

Example line for tip prompt.

info

Example line for info prompt.

warning

Example line for warning prompt.

danger

Example line for danger prompt.

Jekyll Chirpy syntax example:

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

Key Learning Points​

Documentation Value:

  • This serves as a comprehensive reference for the Chirpy Jekyll theme features
  • Shows the progression from basic blog setup to advanced formatting capabilities

Feature Comparison:

  • Jekyll/Chirpy: Liquid templating, Ruby-based, GitHub Pages native
  • Docusaurus: React-based, MDX support, modern build tools
  • Both support math, mermaid, and rich content formatting

Content Migration Insights:

  • Many features translate directly between platforms
  • Syntax differences require careful conversion
  • Documentation posts like this become valuable references during platform transitions

Final post in the blog creation series - documenting the tools and syntax for the chosen platform.