Skip to content

Latest commit

 

History

History
120 lines (87 loc) · 5.45 KB

adding-new-post.md

File metadata and controls

120 lines (87 loc) · 5.45 KB
Raw
author pubDatetime title postSlug featured draft tags ogImage description
Sat Naing
2022-09-23 15:22:00 UTC
Adding new posts in AstroPaper theme
adding-new-posts-in-astropaper-theme
true
false
docs
Some rules & recommendations for creating or adding new posts using AstroPaper theme.

Here are some rules/recommendations, tips & ticks for creating new posts in AstroPaper blog theme.

Table of contents

Frontmatter

Frontmatter is the main place to store some important information about the post (article). Frontmatter lies at the top of the article and is written in YAML format. Read more about frontmatter and its usage in astro documentation.

Here is the list of frontmatter property for each post.

Property Description Remark
title Title of the post. (h1) required*
description Description of the post. Used in post excerpt and site description of the post. required*
pubDatetime Published datetime in ISO 8601 format. required*
author Author of the post. default = SITE.author
postSlug Slug for the post. Will automatically be slugified. default = slugified title
featured Whether or not display this post in featured section of home page default = false
draft Mark this post 'unpublished'. default = false
tags Related keywords for this post. Written in array yaml format. default = others
ogImage OG image of the post. Useful for social media sharing and SEO. default = SITE.ogImage or generated SVG image

Only title, description and pubDatetime fields in frontmatter must be specified.

Title and description (excerpt) are important for search engine optimization (SEO) and thus AstroPaper encourages to include these in blog posts.

slug is the unique identifier of the url. Thus, slug must be unique and different from other posts. The whitespace of slug needs to be separated with - or _ but - is recommended. However, even if you don't write the correct slug, AstroPaper will automatically slugify your incorrect slug. If slug is not specified, the slugified title of the post will be used as slug.

If you omit tags in a blog post (in other words, if no tag is specified), the default tag others will be used as a tag for that post. You can set the default tag in the /src/content/_schemas.ts file.

// src/contents/_schemas.ts
export const blogSchema = z.object({
  // ---
  // replace "others" with whatever you want
  tags: z.array(z.string()).default(["others"]),
  ogImage: z.string().optional(),
  description: z.string(),
});

Sample Frontmatter

Here is the sample frontmatter for a post.

# src/contents/sample-post.md
---
title: The title of the post
author: your name
pubDatetime: 2022-09-21T05:17:19Z
postSlug: the-title-of-the-post
featured: true
draft: false
tags:
  - some
  - example
  - tags
ogImage: ""
description: This is the example description of the example post.
---

Adding table of contents

By default, a post (article) does not include any table of contents (toc). To include toc, you have to specify it in a specific way.

Write Table of contents in h2 format (## in markdown) and place it where you want it to be appeared on the post.

For instance, if you want to place your table of contents just under the intro paragraph (like I usually do), you can do that in the following way.

---
# some frontmatter
---

Here are some recommendations, tips & ticks for creating new posts in AstroPaper blog theme.

## Table of contents

<!-- the rest of the post -->

Headings

There's one thing to note about headings. The AstroPaper blog posts use title (title in the frontmatter) as the main heading of the post. Therefore, the rest of the heading in the post should be using h2 ~ h6.

This rule is not mandatory, but highly recommended for visual, accessibility and SEO purposes.

Bonus

Image compression

When you put images in the blog post, it is recommended that the image is compressed. This will affect the overall performance of the website.

My recommendation for image compression sites.

OG Image

The default OG image will be placed if a post does not specify the OG image. Though not required, OG image related to the post should be specify in the frontmatter. The recommended size for OG image is 1200 X 640 px.

Since AstroPaper v1.4.0, OG images will be generated automatically if not specified. Check out the announcement.