Scripst

Scripst 是一个基于 Typst 的模板包，提供了一套简约高效的文档模板，适用于日常文档、作业、笔记、论文等场景。

🚀 特性

高扩展性：模块化设计，便于对模板进行扩展
多语言设计：针对不同语言进行本地化设计
支持自定义countblock：方便生成定理、题目等其他计数器以及样式

Demo0 Demo1 Demo2

📦 安装

安装 Typst

确保已安装 Typst，可以使用以下命令进行安装：

sudo apt install typst # Debian/Ubuntu
sudo pacman -S typst # Arch Linux
winget install --id Typst.Typst # Windows
brew install typst # macOS

或参考 Typst 官方文档了解更多信息。

下载 Scripst 模板

方法 1：手动下载

访问 Scripst GitHub 仓库
点击 <> Code 按钮
选择 Download ZIP
解压后，将模板文件放入你的项目目录

目录结构建议

project/
├── src/
│   ├── main.typ
│   ├── components.typ
├── pic/
│   ├── image.jpg
├── main.typ
├── chap1.typ
├── chap2.typ

若模板存放于 src/ 目录下，引入方式：

#import "src/main.typ": *

方法 2：使用 Typst 本地包管理

可手动下载 Scripst 并将其存放至：

~/.local/share/typst/packages/local/scripst/1.1.0                 # Linux
%APPDATA%\typst\packages\local\scripst\1.1.0                      # Windows
~/Library/Application Support/typst/packages/local/scripst/1.1.0  # macOS

或者运行如下命令：

cd {data-dir}/typst/packages/local/scripst
git clone https://github.com/An-314/scripst 1.1.0

其中data-dir为Typst的数据目录，如上述Linux系统中的~/.local/share/typst，Windows系统中的%APPDATA%\typst，macOS系统中的~/Library/Application Support/typst。

然后在 Typst 文件中直接引入：

#import "@local/scripst:1.1.0": *

即可使用 Scripst 模板。

使用 typst init 快速创建项目：

typst init @local/scripst:1.1.0 project_name

📄 使用 Scripst

引入 Scripst 模板

在 Typst 文件开头引入模板：

#import "@local/scripst:1.1.0": *

创建 `article` 文档

#show: scripst.with(
  title: [Scripst 的使用方法],
  info: [这是文章的模板],
  author: ("作者1", "作者2", "作者3"),
  time: datetime.today().display(),
  abstract: [摘要内容],
  keywords: ("关键词1", "关键词2", "关键词3"),
  contents: true,
  content_depth: 2,
  matheq_depth: 2,
  lang: "zh",
)

🔧 模板参数

参数	类型	默认值	说明
`template`	`str`	`"article"`	选择模板 (`"article"`, `"book"`, `"report"`)
`title`	`content`, `str`, `none`	`""`	文档标题
`info`	`content`, `str`, `none`	`""`	文档副标题或补充信息
`author`	`array`	`()`	作者列表
`time`	`content`, `str`, `none`	`""`	文档时间
`abstract`	`content`, `str`, `none`	`none`	文档摘要
`keywords`	`array`	`()`	关键词
`preface`	`content`, `str`, `none`	`none`	前言
`font_size`	`length`	`11pt`	字体大小
`contents`	`bool`	`false`	是否生成目录
`content_depth`	`int`	`2`	目录深度
`matheq_depth`	`int`	`2`	数学公式编号深度
`lang`	`str`	`"zh"`	语言 (`"zh"`, `"en"`, `"fr"` 等)

✨ 模板效果示例与说明

📜 贡献

欢迎提交 Issue 或 Pull Request！如果有改进建议，欢迎加入讨论。

GitHub 仓库：Scripst
问题反馈：提交 Issue 进行讨论

📌 字体

本项目默认使用以下字体：

主要字体：CMU Serif, Consolas
备选字体：Linux Libertine
以及SimSun, SimHei, KaiTi等中文字体

使用默认字体前，请确保已安装该字体，或根据需要在./src/configs.typ中进行替换。

📦 依赖

对于部分内容，Scripst 引用了以下 Typst 包：

🎯 TODO

[ ] 加入 beamer 模板