Skip to content

Welcome to AstroPaper-S

A fork of AstroPaper

AstroPaper-S is a fork of AstroPaper v5.2.0, based on Astro.

This fork extends AstroPaper with additional features:

Most of the other features, such as light/dark mode, fuzzy search, sitemap generation, and more, remain largely unchanged.

Usage

For development:

pnpm install
pnpm run dev

To build static site:

pnpm run build

Markdown Frontmatter

PropertyDescRemark
authorAuthor of the postdefault = SITE.author
titleTitle of the post (h1)required*
subtitleSubtitle of the postoptional
descriptionDescription of the post. Used in post excerpt and site description of the postoptional, auto-generated if not given
datepublished datetime in ISO 8601 formatrequired*
updatedModified datetime in ISO 8601 formatoptional
featuredWhether or not display this post in featured section of home pagedefault = false
draftMark this post ‘unpublished’default = false
tagsRelated keywords for this post. Written in array YAML formatdefault = ["Others"]
categoriesCategories for this post. Written in array YAML formatoptional
ogImageOG image of the post. Useful for social media sharing and SEOdefault = SITE.ogImage or generated OG image
tocEnable table of contents for this postdefault = true
commentsEnable comments for this postdefault = false
mathEnable KaTeX for this postdefault = false
canonicalURLCanonical URL (absolute), in case the article already exists on other sourcedefault = Astro.site + Astro.url.pathname
slugSlug for the post. This field is optional but CANNOT be an empty string ("")default = slugified file name
hideEditPostHide editPost button under blog title. This applies only to the current blog post.default = false
timezoneSpecify a timezone in IANA format for the current blog post. This will override the SITE.timezone config for the current blog post.default = SITE.timezone

Also see Adding new posts in AstroPaper theme | AstroPaper and src/content.config.ts


How to Configure AstroPaper-S