mirror of
https://github.com/typst/typst
synced 2025-05-19 03:25:27 +08:00
Add a bit more detail to font
parameter docs
This commit is contained in:
parent
e6ad40004b
commit
90cd1a5a09
@ -66,14 +66,28 @@ pub(super) fn define(global: &mut Scope) {
|
|||||||
/// ```
|
/// ```
|
||||||
#[elem(Construct, PlainText)]
|
#[elem(Construct, PlainText)]
|
||||||
pub struct TextElem {
|
pub struct TextElem {
|
||||||
/// A prioritized sequence of font families.
|
/// A font family name or priority list of font family names.
|
||||||
///
|
///
|
||||||
/// When processing text, Typst tries all specified font families in order
|
/// When processing text, Typst tries all specified font families in order
|
||||||
/// until it finds a font that has the necessary glyphs. In the example
|
/// until it finds a font that has the necessary glyphs. In the example
|
||||||
/// below, the font `Inria Serif` is preferred, but since it does not
|
/// below, the font `Inria Serif` is preferred, but since it does not
|
||||||
/// contain Arabic glyphs, the arabic text uses `Noto Sans Arabic` instead.
|
/// contain Arabic glyphs, the arabic text uses `Noto Sans Arabic` instead.
|
||||||
///
|
///
|
||||||
|
/// The collection of available fonts differs by platform:
|
||||||
|
///
|
||||||
|
/// - In the web app, you can see the list of available fonts by clicking on
|
||||||
|
/// the "Ag" button. You can provide additional fonts by uploading `.ttf`
|
||||||
|
/// or `.otf` files into your project. They will be discovered
|
||||||
|
/// automatically.
|
||||||
|
///
|
||||||
|
/// - Locally, Typst uses your installed system fonts. In addition, you can
|
||||||
|
/// use the `--font-path` argument or `TYPST_FONT_PATHS` environment
|
||||||
|
/// variable to add directories that should be scanned for fonts.
|
||||||
|
///
|
||||||
/// ```example
|
/// ```example
|
||||||
|
/// #set text(font: "PT Sans")
|
||||||
|
/// This is sans-serif.
|
||||||
|
///
|
||||||
/// #set text(font: (
|
/// #set text(font: (
|
||||||
/// "Inria Serif",
|
/// "Inria Serif",
|
||||||
/// "Noto Sans Arabic",
|
/// "Noto Sans Arabic",
|
||||||
@ -81,7 +95,6 @@ pub struct TextElem {
|
|||||||
///
|
///
|
||||||
/// This is Latin. \
|
/// This is Latin. \
|
||||||
/// هذا عربي.
|
/// هذا عربي.
|
||||||
///
|
|
||||||
/// ```
|
/// ```
|
||||||
#[default(FontList(vec![FontFamily::new("Linux Libertine")]))]
|
#[default(FontList(vec![FontFamily::new("Linux Libertine")]))]
|
||||||
pub font: FontList,
|
pub font: FontList,
|
||||||
|
Loading…
x
Reference in New Issue
Block a user