caisin/typst
1
0
Fork 0
mirror of https://github.com/typst/typst synced 2025-05-13 20:46:23 +08:00
Code Issues Packages Projects Releases Wiki Activity

Documentation improvements (#5888)

Browse Source
This commit is contained in:
Malo 2025-02-23 12:31:28 +01:00 committed by GitHub
parent 55bc5f4c94
commit 56f4fa2b4d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
crates/typst-library/src/foundations/symbol.rs
View File

@ -21,6 +21,7 @@ use crate::foundations::{
/// be accessed using [field access notation]($scripting/#fields): /// be accessed using [field access notation]($scripting/#fields):
/// ///
/// - General symbols are defined in the [`sym` module]($category/symbols/sym) /// - General symbols are defined in the [`sym` module]($category/symbols/sym)
/// and are accessible without the `sym.` prefix in math mode.
/// - Emoji are defined in the [`emoji` module]($category/symbols/emoji) /// - Emoji are defined in the [`emoji` module]($category/symbols/emoji)
/// ///
/// Moreover, you can define custom symbols with this type's constructor /// Moreover, you can define custom symbols with this type's constructor

2
crates/typst-library/src/visualize/color.rs
View File

@ -130,7 +130,7 @@ static TO_SRGB: LazyLock<qcms::Transform> = LazyLock::new(|| {
/// ///
/// # Predefined color maps /// # Predefined color maps
/// Typst also includes a number of preset color maps that can be used for /// Typst also includes a number of preset color maps that can be used for
/// [gradients]($gradient.linear). These are simply arrays of colors defined in /// [gradients]($gradient/#stops). These are simply arrays of colors defined in
/// the module `color.map`. /// the module `color.map`.
/// ///
/// ```example /// ```example

11
crates/typst-library/src/visualize/gradient.rs
View File

@ -70,6 +70,9 @@ use crate::visualize::{Color, ColorSpace, WeightedColor};
/// the offsets when defining a gradient. In this case, Typst will space all /// the offsets when defining a gradient. In this case, Typst will space all
/// stops evenly. /// stops evenly.
/// ///
/// Typst predefines color maps that you can use as stops. See the
/// [`color`]($color/#predefined-color-maps) documentation for more details.
///
/// # Relativeness /// # Relativeness
/// The location of the `{0%}` and `{100%}` stops depends on the dimensions /// The location of the `{0%}` and `{100%}` stops depends on the dimensions
/// of a container. This container can either be the shape that it is being /// of a container. This container can either be the shape that it is being
@ -157,10 +160,6 @@ use crate::visualize::{Color, ColorSpace, WeightedColor};
/// ) /// )
/// ``` /// ```
/// ///
/// # Presets
/// Typst predefines color maps that you can use with your gradients. See the
/// [`color`]($color/#predefined-color-maps) documentation for more details.
///
/// # Note on file sizes /// # Note on file sizes
/// ///
/// Gradients can be quite large, especially if they have many stops. This is /// Gradients can be quite large, especially if they have many stops. This is
@ -288,7 +287,7 @@ impl Gradient {
/// )), /// )),
/// ) /// )
/// ``` /// ```
#[func] #[func(title = "Radial Gradient")]
fn radial( fn radial(
span: Span, span: Span,
/// The color [stops](#stops) of the gradient. /// The color [stops](#stops) of the gradient.
@ -402,7 +401,7 @@ impl Gradient {
/// )), /// )),
/// ) /// )
/// ``` /// ```
#[func] #[func(title = "Conic Gradient")]
pub fn conic( pub fn conic(
span: Span, span: Span,
/// The color [stops](#stops) of the gradient. /// The color [stops](#stops) of the gradient.

4
docs/reference/groups.yml
View File

@ -170,8 +170,8 @@
category: symbols category: symbols
path: ["emoji"] path: ["emoji"]
details: | details: |
Named emoji. Named emojis.
For example, `#emoji.face` produces the 😀 emoji. If you frequently use For example, `#emoji.face` produces the 😀 emoji. If you frequently use
certain emojis, you can also import them from the `emoji` module (`[#import certain emojis, you can also import them from the `emoji` module (`[#import
emoji: face]`) to use them without the `#emoji.` prefix. emoji: face]`) to use them without the `emoji.` prefix.