docs: update theme guide

This commit is contained in:
radishzzz 2025-04-13 13:15:21 +01:00
parent 69de0217bd
commit 37b95a4e37
6 changed files with 50 additions and 49 deletions

View file

@ -10,11 +10,11 @@ lang: en
abbrlink: theme-guide
---
Retypeset is a static blog theme based on the [Astro](https://astro.build/) framework. Inspired by [Typography](https://astro-theme-typography.vercel.app/), Retypeset establishes a new visual standard and reimagines the layout of all pages, creating a reading experience reminiscent of paper books, reviving the beauty of typography. Details in every sight, elegance in every space.
Retypeset is a static blog theme based on the [Astro](https://astro.build/) framework. This guide covers the theme configuration, how to create new posts, and additional configuration options.
## Theme Configuration
Below is the theme configuration guide for Retypeset. Customize your blog by modifying the configuration file [src/config.ts](https://github.com/radishzzz/astro-theme-retypeset/blob/master/src/config.ts).
Customize your blog by modifying the theme configuration file [src/config.ts](https://github.com/radishzzz/astro-theme-retypeset/blob/master/src/config.ts).
### Site Information
@ -299,9 +299,10 @@ shikiConfig: {
}
}
```
### Article Excerpt
Character limit for automatic article excerpts.
Character count limit for automatic article excerpts.
```ts
// src/utils/description.ts
@ -310,16 +311,16 @@ const EXCERPT_LENGTHS: Record<ExcerptScene, {
cjk: number // Chinese, Japanese, Korean
other: number // Other languages
}> = {
list: { // Homepage
cjk: 120, // Excerpt limit is 120 characters
other: 240, // Excerpt limit is 240 characters
list: { // Homepage article list
cjk: 120, // Auto-excerpts first 120 characters
other: 240, // Auto-excerpts first 240 characters
},
}
```
### Open Graph
Styling for Open Graph social images.
Open Graph social image styles.
```ts
// src/pages/og/[...image].ts
@ -348,7 +349,7 @@ getImageOptions: (_path, page) => ({
### RSS Feed
Color scheme for the RSS feed page.
RSS feed page styles.
```html
<!-- public/rss-style.xsl -->

View file

@ -10,11 +10,11 @@ lang: es
abbrlink: theme-guide
---
Retypeset es un tema de blog estático basado en el framework [Astro](https://astro.build/). Inspirado por [Typography](https://astro-theme-typography.vercel.app/), Retypeset establece un nuevo estándar visual y reimagina el diseño de todas las páginas, creando una experiencia de lectura similar a la de los libros impresos, reviviendo la belleza de la tipografía. Detalles en cada mirada, elegancia en cada espacio.
Retypeset es un tema de blog estático basado en el framework [Astro](https://astro.build/). Esta guía cubre la configuración del tema, cómo crear nuevas publicaciones y opciones de configuración adicionales.
## Configuración del Tema
A continuación se presenta la guía de configuración del tema Retypeset. Personaliza tu blog modificando el archivo de configuración [src/config.ts](https://github.com/radishzzz/astro-theme-retypeset/blob/master/src/config.ts).
Personaliza tu blog modificando el archivo de configuración del tema [src/config.ts](https://github.com/radishzzz/astro-theme-retypeset/blob/master/src/config.ts).
### Información del Sitio
@ -302,7 +302,7 @@ shikiConfig: {
### Extracto de Artículo
Límite de caracteres para extractos automáticos de artículos.
Límite de cantidad de caracteres para extractos automáticos de artículos.
```ts
// src/utils/description.ts
@ -311,16 +311,16 @@ const EXCERPT_LENGTHS: Record<ExcerptScene, {
cjk: number // Chino, Japonés, Coreano
other: number // Otros idiomas
}> = {
list: { // Página principal
cjk: 120, // Límite de extracto es 120 caracteres
other: 240, // Límite de extracto es 240 caracteres
list: { // Lista de artículos en página principal
cjk: 120, // Extrae automáticamente los primeros 120 caracteres
other: 240, // Extrae automáticamente los primeros 240 caracteres
},
}
```
### Open Graph
Estilo para imágenes sociales Open Graph.
Estilos de imágenes sociales Open Graph.
```ts
// src/pages/og/[...image].ts
@ -349,7 +349,7 @@ getImageOptions: (_path, page) => ({
### Canal RSS
Esquema de colores para la página de feed RSS.
Estilos de página del feed RSS.
```html
<!-- public/rss-style.xsl -->

View file

@ -10,11 +10,11 @@ lang: ja
abbrlink: theme-guide
---
Retypesetは、日本語では「再組版」と呼ばれる、[Astro](https://astro.build/) フレームワークをベースにした静的ブログテーマです。[活版印字](https://astro-theme-typography.vercel.app/) からデザインのインスピレーションを得て、新しい視覚的な規範を確立し、すべてのページのレイアウトを再構成することで、紙の書籍のような読書体験を提供し、版面の美しさを蘇らせます。見るものすべてが細部にこだわり、限られたスペースの中に優雅さを表現しています。
Retypesetは[Astro](https://astro.build/)フレームワークをベースにした静的ブログテーマで、日本語では「再編集」を意味します。このガイドではRetypesetテーマの設定方法、新しい記事の作成方法、その他の設定オプションについて説明します。
## テーマ設定
以下はRetypesetのテーマ設定ガイドです。設定ファイル [src/config.ts](https://github.com/radishzzz/astro-theme-retypeset/blob/master/src/config.ts) を修正してブログをカスタマイズできます。
設定ファイル [src/config.ts](https://github.com/radishzzz/astro-theme-retypeset/blob/master/src/config.ts) を修正してブログをカスタマイズできます。
### サイト情報
@ -302,7 +302,7 @@ shikiConfig: {
### 記事の抜粋
記事の自動抜粋の文字数制限。
記事の自動抜粋の文字数制限。
```ts
// src/utils/description.ts
@ -311,16 +311,16 @@ const EXCERPT_LENGTHS: Record<ExcerptScene, {
cjk: number // 中国語、日本語、韓国語
other: number // その他の言語
}> = {
list: { // ホームページ
cjk: 120, // 抜粋は120文字まで
other: 240, // 抜粋は240文字まで
list: { // ホームページ記事リスト
cjk: 120, // 先頭から120文字を自動抜粋
other: 240, // 先頭から240文字を自動抜粋
},
}
```
### Open Graph
Open Graph ソーシャル画像スタイル。
Open Graphソーシャル画像スタイル。
```ts
// src/pages/og/[...image].ts
@ -349,7 +349,7 @@ getImageOptions: (_path, page) => ({
### RSSフィード
RSSフィードページのカラースキーム
RSSフィードページスタイル
```html
<!-- public/rss-style.xsl -->

View file

@ -10,11 +10,11 @@ lang: ru
abbrlink: theme-guide
---
Retypeset — это статическая тема блога, основанная на фреймворке [Astro](https://astro.build/). Вдохновленная [Typography](https://astro-theme-typography.vercel.app/), Retypeset устанавливает новый визуальный стандарт и переосмысливает компоновку всех страниц, создавая опыт чтения, напоминающий печатные книги, возрождая красоту типографики. Детали в каждом взгляде, элегантность в каждом пространстве.
Retypeset - это статическая тема для блога, основанная на фреймворке [Astro](https://astro.build/). Это руководство охватывает настройку темы, создание новых статей и дополнительные параметры конфигурации.
## Конфигурация темы
Ниже приведено руководство по конфигурации темы Retypeset. Настройте свой блог, изменяя конфигурационный файл [src/config.ts](https://github.com/radishzzz/astro-theme-retypeset/blob/master/src/config.ts).
Настройте свой блог, изменяя конфигурационный файл темы [src/config.ts](https://github.com/radishzzz/astro-theme-retypeset/blob/master/src/config.ts).
### Информация о сайте
@ -302,7 +302,7 @@ shikiConfig: {
### Отрывок статьи
Лимит символов для автоматических отрывков статей.
Лимит количества символов для автоматических отрывков статей.
```ts
// src/utils/description.ts
@ -311,16 +311,16 @@ const EXCERPT_LENGTHS: Record<ExcerptScene, {
cjk: number // Китайский, Японский, Корейский
other: number // Другие языки
}> = {
list: { // Главная страница
cjk: 120, // Лимит отрывка 120 символов
other: 240, // Лимит отрывка 240 символов
list: { // Список статей на главной странице
cjk: 120, // Автоматически берет первые 120 символов
other: 240, // Автоматически берет первые 240 символов
},
}
```
### Open Graph
Стилизация для социальных изображений Open Graph.
Стили изображений Open Graph для социальных сетей.
```ts
// src/pages/og/[...image].ts
@ -349,7 +349,7 @@ getImageOptions: (_path, page) => ({
### RSS-лента
Цветовая схема для страницы RSS-ленты.
Стили страницы RSS-ленты.
```html
<!-- public/rss-style.xsl -->

View file

@ -10,11 +10,11 @@ lang: zh-tw
abbrlink: theme-guide
---
Retypeset 是一款基於 [Astro](https://astro.build/) 框架的靜態部落格主題,中文名為重新編排。本主題以 [活版印字](https://astro-theme-typography.vercel.app/) 為設計靈感,通過建立全新的視覺規範,對所有頁面進行重新編排,打造紙質書頁般的閱讀體驗,再現版式之美。所見皆為細節,方寸盡顯優雅
Retypeset 是一款基於 [Astro](https://astro.build/) 框架的靜態部落格主題,中文名為重新編排。本文是 Retypeset 主題的上手指南,包括主題配置介紹,如何創建新文章和更多配置說明
## 主題配置
以下為 Retypeset 的主題配置介紹。通過修改配置文件 [src/config.ts](https://github.com/radishzzz/astro-theme-retypeset/blob/master/src/config.ts) 來自定義你的部落格。
通過修改主題配置文件 [src/config.ts](https://github.com/radishzzz/astro-theme-retypeset/blob/master/src/config.ts) 來自定義你的部落格。
### 站點信息
@ -302,7 +302,7 @@ shikiConfig: {
### 文章摘要
文章自動摘要的字符限制。
文章自動摘要的字符數量限制。
```ts
// src/utils/description.ts
@ -311,16 +311,16 @@ const EXCERPT_LENGTHS: Record<ExcerptScene, {
cjk: number // 中文、日文、韓文
other: number // 其他語言
}> = {
list: { // 首頁
cjk: 120, // 摘要限制為 120 字
other: 240, // 摘要限制為 240 字
list: { // 首頁文章列表
cjk: 120, // 自動摘要前 120 字
other: 240, // 自動摘要前 240 字
},
}
```
### Open Graph
Open Graph 社交圖片樣式。
Open Graph 社交圖片樣式。
```ts
// src/pages/og/[...image].ts
@ -349,7 +349,7 @@ getImageOptions: (_path, page) => ({
### RSS 訂閱
RSS 訂閱頁面的配色。
RSS 訂閱頁配色。
```html
<!-- public/rss-style.xsl -->

View file

@ -10,11 +10,11 @@ lang: zh
abbrlink: theme-guide
---
Retypeset 是一款基于 [Astro](https://astro.build/) 框架的静态博客主题,中文名为重新编排。本主题以 [活版印字](https://astro-theme-typography.vercel.app/) 为设计灵感,通过建立全新的视觉规范,对所有页面进行重新编排,打造纸质书页般的阅读体验,再现版式之美。所见皆为细节,方寸尽显优雅
Retypeset 是一款基于 [Astro](https://astro.build/) 框架的静态博客主题,中文名为重新编排。本文是 Retypeset 主题的上手指南,包括主题配置介绍,如何创建新文章和更多配置说明
## 主题配置
以下为 Retypeset 的主题配置介绍。通过修改配置文件 [src/config.ts](https://github.com/radishzzz/astro-theme-retypeset/blob/master/src/config.ts) 来自定义你的博客。
通过修改主题配置文件 [src/config.ts](https://github.com/radishzzz/astro-theme-retypeset/blob/master/src/config.ts) 来自定义你的博客。
### 站点信息
@ -292,7 +292,7 @@ src/content/posts/2025/03/apple.md -> example.com/es/posts/banana/
shikiConfig: {
// 可选主题https://shiki.style/themes
// 背景色默认跟随博客主题,而非语法高亮主题
// 背景色固定跟随博客主题,而非语法高亮主题
themes: {
light: 'github-light' // 亮色主题
dark: 'github-dark' // 暗色主题
@ -302,7 +302,7 @@ shikiConfig: {
### 文章摘要
文章自动摘要的字符限制。
文章自动摘要的字符数量限制。
```ts
// src/utils/description.ts
@ -311,16 +311,16 @@ const EXCERPT_LENGTHS: Record<ExcerptScene, {
cjk: number // 中文、日文、韩文
other: number // 其他语言
}> = {
list: { // 首页
cjk: 120, // 摘要限制为 120 字
other: 240, // 摘要限制为 240 字
list: { // 首页文章列表
cjk: 120, // 自动摘要前 120 字
other: 240, // 自动摘要前 240 字
},
}
```
### Open Graph
Open Graph 社交图片样式。
Open Graph 社交图片样式。
```ts
// src/pages/og/[...image].ts
@ -349,7 +349,7 @@ getImageOptions: (_path, page) => ({
### RSS 订阅
RSS 订阅页面的配色。
RSS 订阅页配色。
```html
<!-- public/rss-style.xsl -->