Skip to content

axiomst:0.1.0 #2893

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
176 changes: 0 additions & 176 deletions LICENSE

This file was deleted.

69 changes: 0 additions & 69 deletions README.md

This file was deleted.

21 changes: 21 additions & 0 deletions packages/preview/axiomst/0.1.0/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2025 Reza

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
83 changes: 83 additions & 0 deletions packages/preview/axiomst/0.1.0/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
# axiomst

a clean, elegant template for academic problem sets and homework assignments in [typst](https://typst.app/).

## Features
- Professional-looking problem set layout with title page
- Automatic problem numbering
- Customizable problem boxes with titles
- Support for collaborator attribution
- Page headers and footers with automatic page numbering
- Clean, academic aesthetic with customizable accent colors

## Quick Start
The easiest way to get started is through the Typst web app,
```
typst init @preview/axiomst:0.1.0
```

Or click "Create from template" in the Typst web app and search for "axiomst".

## Usage
Here's a basic example of how to use the template,

```typst
#import "@preview/axiomst:0.1.0": *

#show: homework.with(
title: "Problem Set 1",
author: "Your Name",
course: "MATH 101: Advanced Linear Algebra",
email: "[email protected]",
date: datetime.today(),
due-date: "April 30, 2025",
collaborators: ["Alice Smith", "Bob Johnson"],
)

#problem(title: "Vector Spaces")[
Let $V$ be a vector space over a field $F$. Prove the following properties:

1. The zero vector $0_V$ is unique.
2. For each $v in V$, the additive inverse $-v$ is unique.
3. If $a in F$ and $a cdot v = 0_V$ for some $v in V$, then either $a = 0$ or $v = 0_V$.
]

// Your solution here...
```

## Configuration Options
### Homework Template
The main `homework()` function accepts the following parameters:

- `title`: The title of the assignment
- `author`: Your name
- `course`: Course code or name
- `email`: Your email address
- `date`: Date of submission (defaults to today)
- `due-date`: When the assignment is due (optional)
- `collaborators`: List of people you worked with (optional)

### Problem Function
Individual problems can be created with the `problem()` function:

- `title`: Title of the problem
- `color`: Color theme for this specific problem box
- `numbered`: Whether to include automatic problem numbering (default: true)

## Customization
The template is designed to be easily customizable. Here are some common adjustments:

```typst
// Change the enumeration style for lists
#set enum(numbering: "a)")

// Use LaTeX-like font
#set text(font: "New Computer Modern")

// Enable equation numbering
#set math.equation(numbering: "(1)")
```

## License

This project is licensed under the MIT License - see the LICENSE file for details.
Loading
Loading