added general info and removed unnecessary code
This commit is contained in:
21
README.md
21
README.md
@ -1,14 +1,17 @@
|
|||||||
# Typst Template for NURE Works
|
# Typst Template for NURE Works
|
||||||
|
|
||||||
> [!INFO]
|
> [!WARNING]
|
||||||
> Needs more work, but it is functional and ready for use.
|
> 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
|
## TODO
|
||||||
- Add more information about the template.
|
- Add more information about the template.
|
||||||
|
|
||||||
## General Info
|
## 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
|
### Templates
|
||||||
|
|
||||||
@ -35,23 +38,22 @@ This template:
|
|||||||
To use the template, include it in your project and utilize the provided functions:
|
To use the template, include it in your project and utilize the provided functions:
|
||||||
|
|
||||||
```typst
|
```typst
|
||||||
#import "path/to/template.typ": * // Import the template
|
// Import the template
|
||||||
#import "@preview/indenta:0.0.3": fix-indent // Import indentation fix utility
|
#import "path/to/template.typ": *
|
||||||
|
|
||||||
|
// Setup the document
|
||||||
#show: pz-lb-template.with(
|
#show: pz-lb-template.with(
|
||||||
title: "Some title",
|
title: "Some title",
|
||||||
)
|
)
|
||||||
|
|
||||||
#show: fix-indent()
|
// Write your content
|
||||||
|
|
||||||
#v(-spacing)
|
#v(-spacing)
|
||||||
== Purpose
|
== Purpose
|
||||||
Some text
|
Some text
|
||||||
```
|
```
|
||||||
|
|
||||||
### Notes:
|
### Notes:
|
||||||
1. You must use the `fix-indent` function from `@preview/indenta` to correct indentation after the title.
|
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.
|
||||||
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.
|
|
||||||
|
|
||||||
### Example Project Structure
|
### Example Project Structure
|
||||||
```
|
```
|
||||||
@ -64,4 +66,3 @@ project-folder/
|
|||||||
│ ├── ...
|
│ ├── ...
|
||||||
├── ...
|
├── ...
|
||||||
```
|
```
|
||||||
This setup ensures that `main.typ` includes and applies the template correctly.
|
|
||||||
|
@ -1,5 +1,4 @@
|
|||||||
#import "template.typ": *
|
#import "template.typ": *
|
||||||
#import "@preview/indenta:0.0.3": fix-indent
|
|
||||||
|
|
||||||
#let author = (
|
#let author = (
|
||||||
name: "Ситник Є. С.",
|
name: "Ситник Є. С.",
|
||||||
@ -106,5 +105,3 @@
|
|||||||
bib_path: "bibl.yml",
|
bib_path: "bibl.yml",
|
||||||
appendices: appendices,
|
appendices: appendices,
|
||||||
)
|
)
|
||||||
|
|
||||||
#show: fix-indent()
|
|
||||||
|
Reference in New Issue
Block a user