383 文字
2 分
Comprehensive Guide for Blogging

IMPORTANT

Read Docs from Astro first.
Github-flavored Markdown is used as default syntax.
Math resolver: Katex

Where are the posts#

Your post files should be placed in src/content/posts/ directory.
You can also create sub-directories to better organize your posts and assets.

src/content/posts/
├── post-1.md
└── post-2/
    ├── cover.png
    └── index.md

Frontmatter#

---
title: "Some title"
published: 1970-01-01
updated: 1970-01-02
description: "Some description"
image: "https://example.com/example.jpg"
tags: ["Atag", "AnotherTag"]
category: "Some category"
draft: false
lang: "en"
---
AttributeDescription
titleThe title of the post.
publishedThe date the post was published.
updatedThe date the post was updated.
descriptionA short description of the post. Displayed on index page.
imageThe cover image path of the post.
tagsThe tags of the post.
categoryThe category of the post.
draftIf this post is still a draft, which won’t be displayed.
langThe language of this post. Used when generating searchdb with pagefind.

Situations for image:

  1. Start with http:// or https://: Use web image
  2. Start with /: For image in public dir
  3. With none of the prefixes: Relative to the markdown file

Heading#

# First-level heading

## Second-level heading

### Third-level heading

#### Fourth-level heading

##### Fifth-level heading

###### Sixth-level heading
TIP

Only first to third level heading will be shown in toc.
To get links for heading, just render post locally and get links from browser.

Text format#

Bold
Italicized
Mistaken
Subscript
Superscript
Underlined
Dash-Dash—

Centered


☺…

Quote#

Quote

Code#

This is some code

apt upgrade -y
apt autoremove --purge
TIP

To use 3 backticks in code, use 4 backticks to wrap the codeblock.
To use codeblock in a list, indent the codeblock with 8 spaces.
Language hints are in Languages | Shiki.

Blog

Custom redirect in post#

<a name="redirect-to-top"></a>

Redirect to top

Paragraph#

This is the first line.
This is the second line.

This is another paragraph.

Image#

Banner

List#

  1. This is the first item.
    • This is an item
      • This is an item
  2. This is the second item.

Task#

  • Finished
  • Not finished

Footnote#

This is a footnote1.

Alert#

NOTE

This is a note.

TIP

This is a tip.

IMPORTANT

This is a important message.

WARNING

This is a warning.

CAUTION

This is a caution

This is a custom title

This is another note.

Hidden comment#

This is some text.

Escape markdown format#

Add a backslash (\) before the markdown character. For example, *This is not markdown*.

Tables#

CAUTION

Not working properly, see Bug: table in post is not aligned per markdown setting.

Key 1Item 2Key 3Key 4
Value 1Value 2Value 3Value |4

Collapsed content#

This should be unfolded by default

This is some content

Math#

3x1+(1+x)2\sqrt{3x-1}+(1+x)^2

π=3.1415926535  8979323846  2643383279  5028841971  6939937510  5820974944  5923078164  0628620899  8628034825  3421170679  \begin{equation*} \pi =3.1415926535 \;8979323846\;2643383279\;5028841971\;6939937510\;5820974944 \;5923078164\;0628620899\;8628034825\;3421170679\;\ldots \end{equation*}
TIP

To escape math syntax, use \$ inside math block, use <span>$</span> outside math block (only for inline).

Github repo#

Amia33
/
fuwari-sakunacf
Waiting for api.github.com...
00K
0K
0K
Waiting...

Video#

Footnotes#

  1. This is the information.

Comprehensive Guide for Blogging
https://3972712.xyz/posts/guide/
作者
結城さくな
公開日
2025-05-26
ライセンス
CC BY-NC-SA 4.0