caisin/typst
1
0
Fork 0
mirror of https://github.com/typst/typst synced 2025-07-27 06:17:53 +08:00
Code Issues Packages Projects Releases Wiki Activity

Mention text.costs and page.height in the docs of pagebreak

Browse Source
This commit is contained in:
Y.D.X. 2025-07-24 18:24:21 +08:00
parent 7278d887cf
commit b05721869c
No known key found for this signature in database
GPG Key ID: 4BEB459A2C828AEA
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
crates/typst-library/src/layout/page.rs
View File

@ -397,6 +397,12 @@ impl LocalName for PageElem {
/// == Compound Theory /// == Compound Theory
/// In 1984, the first ... /// In 1984, the first ...
/// ``` /// ```
///
/// Note that even without manual page breaks, the content will be automatically
/// paginated based on the size of the content and the page. You could adjust
/// [costs]($text.costs) to fine-tune the algorithm that prevents widows and
/// orphans. You can also set [the page height]($page.height) to `{auto}` to
/// let the page grow dynamically until a manual page break occurs.
#[elem(title = "Page Break")] #[elem(title = "Page Break")]
pub struct PagebreakElem { pub struct PagebreakElem {
/// If `{true}`, the page break is skipped if the current page is already /// If `{true}`, the page break is skipped if the current page is already