Scripst is a template package based on Typst, offering a set of simple and efficient document templates suitable for everyday documents, assignments, notes, papers, and other scenarios.

📑 Contents

• 📑 Contents
• 🚀 Features
• 📦 Installation
  • Install Typst
  • Download Scripst Template
    • Method 1: Download Manually
    • Method 2: Use Typst Local Package Management
• 📄 Using Scripst
  • Import Scripst Template
  • Create article Document
• 🔧 Template Parameters
• 🆕 countblock Module
  • Creating and Registering a countblock
  • Using countblock
  • Encapsulating the countblock Module
• ✨ Template Examples and Explanations
  • Article
  • Book
  • Report
• 📜 Contributing
• 📌 Fonts
• 🔗 Dependencies
• 📝 License
• 🎯 TODO

🚀 Features

• High Extensibility: Modular design, easy to extend the templates.
• Multilingual Design: Localization for different languages.
• Supports module countblock, which allows custom names and colors, includes a built-in counter, and can be referenced anywhere in the document. It can be used for theorems, problems, notes, etc. For more details, see 🆕 countblock Module.

📦 Installation

Install Typst

Make sure Typst is installed. You can install it using the following commands:

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

Or refer to the Typst official documentation for more information.

Download Scripst Template

Should you need to use the template locally, or should you need to make adjustments to the template, you can download the Scripst template manually.

Method 1: Download Manually

1. Visit the Scripst GitHub repository
2. Click the <> Code button
3. Choose Download ZIP
4. After extraction, place the template files into your project directory.

Suggested directory structure

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

If the template is stored in the src/ directory, import it like this:

#import "src/main.typ": *

Method 2: Use Typst Local Package Management

You can manually download Scripst and store it in:

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

or using these commands:

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

Where data-dir refers to Typst’s data directory, such as ~/.local/share/typst for Linux, %APPDATA%\typst for Windows, and ~/Library/Application Support/typst for macOS.

Then import directly in your Typst file:

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

Now you can use the Scripst template.

Use typst init to quickly create a project:

typst init @preview/scripst:1.1.0 project_name

📄 Using Scripst

Import Scripst Template

Import the template at the beginning of your Typst file:

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

Create article Document

#show: scripst.with(
  title: [How to Use Scripst],
  info: [This is an article template],
  author: ("Author1", "Author2", "Author3"),
  time: datetime.today().display(),
  abstract: [Abstract content],
  keywords: ("Keyword1", "Keyword2", "Keyword3"),
  contents: true,
  content-depth: 2,
  matheq-depth: 2,
  lang: "en",
)

🔧 Template Parameters

🆕 countblock Module

The countblock module is a customizable module where you can set the name and color, and it comes with a built-in counter that can be referenced anywhere in the document. It can be used to create blocks for theorems, definitions, problems, notes, and more.

Below is an example of a countblock module:

Creating and Registering a countblock

Scripst provides several default countblock modules, which already have preset names, colors, and registered counters:

#let cb = (
  "thm": ("Theorem", color.blue),
  "def": ("Definition", color.green),
  "prob": ("Problem", color.purple),
  "prop": ("Proposition", color.purple-grey),
  "ex": ("Example", color.green-blue),
  "note": ("Note", color.grey),
  "cau": ("⚠️", color.red),
)

You can also define your own countblock modules:

#let cb = add-countblock("test", "This is a test", teal) // Define a "test" countblock
#show: register-countblock.with("test") // Register the countblock

This allows you to use the test module in your document.

Using countblock

You can use the countblock module in the document as follows:

#countblock(
  name,
  subname,
  count: true,
  cb: cb,
  lab: none,
)[...]

Parameter descriptions:

For example:

#countblock("thm", subname: [_Fermat's Last Theorem_], lab: "fermat", cb)[

  No three $a, b, c \in \mathbb{N}^+$ can satisfy the equation
  $
    a^n + b^n = c^n
  $
  for any integer value of $n$ greater than 2.
]
#proof[Cuius rei demonstrationem mirabilem sane detexi. Hanc marginis exiguitas non caperet.]
Fermat did not provide a public proof for @fermat.

This will create a theorem block and allow it to be referenced in the document.

Encapsulating the countblock Module

You can encapsulate the countblock module into a function for repeated use in the document:

#let test = countblock.with("test", cb)

This allows you to use the test function in the document:

#test[...]

Additionally, the default countblock modules provided by Scripst have already been encapsulated, allowing you to use them directly as #theorem, #definition, #problem, #proposition, #example, #note, and #caution.

✨ Template Examples and Explanations

Article

Aritcle Demo

Book

Book Demo (Only in Simplified Chinese)

Report

Report Demo (Only in Simplified Chinese)

📜 Contributing

Feel free to submit issues or pull requests! If you have any improvement suggestions, join the discussion.

• GitHub Repository: Scripst
• Issue Feedback: Submit an issue to discuss

📌 Fonts

This project uses the following fonts by default:

• Primary fonts: CMU Serif, Consolas
• Alternative fonts: Linux Libertine
• Chinese fonts such as SimSun, SimHei, KaiTi, etc.

If using these default fonts, please make sure they are correctly installed. Otherwise, replace them if needed in ./src/configs.typ.

🔗 Dependencies

For certain content, Scripst uses the following Typst packages:

• tablem
• physica

📝 License

This project is licensed under the MIT License.

🎯 TODO

• [ ] Add beamer template
• [ ] Add more configuration options