unexplrd/typst_nure_template
1
0
Fork 0
forked from pencelheimer/typst_nure_template
Code Pull Requests Activity

added general info and removed unnecessary code

Browse Source
This commit is contained in:
Sytnyk Yehor
2025-02-14 01:48:34 +02:00
parent 003f327c71
commit f2833b62c6
2 changed files with 11 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -1,14 +1,17 @@
# Typst Template for NURE Works
> [!INFO]
> Needs more work, but it is functional and ready for use.
> [!WARNING]
> This branch is using the Typst v0.13.0-rc1. To install it use the following command:
> ```bash
> cargo install --git https://github.com/typst/typst --branch 0.13 --locked typst-cli
> ```
## TODO
- Add more information about the template.
## General Info
This project contains two template functions and some utilities for writing NURE works. All functions include documentation comments inside them, so you can explore all possibilities using LSP/IntelliSense.
This project contains two template functions and some utilities for writing NURE works. All functions include documentation comments inside them, so you can explore all possibilities using LSP.
### Templates
@ -35,23 +38,22 @@ This template:
To use the template, include it in your project and utilize the provided functions:
```typst
#import "path/to/template.typ": * // Import the template
#import "@preview/indenta:0.0.3": fix-indent // Import indentation fix utility
// Import the template
#import "path/to/template.typ": *
// Setup the document
#show: pz-lb-template.with(
title: "Some title",
)
#show: fix-indent()
// Write your content
#v(-spacing)
== Purpose
Some text
```
### Notes:
1. You must use the `fix-indent` function from `@preview/indenta` to correct indentation after the title.
2. Use `#v(-spacing)` to remove vertical spacing between titles (this cannot be automatically handled by the template). Notice that the `spacing` variable used here is imported from the template.
1. Use `#v(-spacing)` to remove vertical spacing between titles (this cannot be automatically handled by the template). Variable `spacing` used here is imported from the template.
### Example Project Structure
```
@ -64,4 +66,3 @@ project-folder/
│ ├── ...
├── ...
```
This setup ensures that `main.typ` includes and applies the template correctly.