Add note about embedding svg images (#1243)

This commit is contained in:
Laurenz Stampfl 2023-05-19 14:41:33 +02:00 committed by GitHub
parent 85ea0350e4
commit f9ab828e29
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -11,6 +11,10 @@ use crate::text::families;
/// ///
/// Supported formats are PNG, JPEG, GIF and SVG. /// Supported formats are PNG, JPEG, GIF and SVG.
/// ///
/// _Note:_ Work on SVG export is ongoing and there might be visual inaccuracies
/// in the resulting PDF. Make sure to double-check embedded SVG images. If you
/// have an issue, also feel free to report it on [GitHub][gh-svg].
///
/// ## Example { #example } /// ## Example { #example }
/// ```example /// ```example
/// #figure( /// #figure(
@ -22,6 +26,8 @@ use crate::text::families;
/// ) /// )
/// ``` /// ```
/// ///
/// [gh-svg]: https://github.com/typst/typst/issues?q=is%3Aopen+is%3Aissue+label%3Asvg
///
/// Display: Image /// Display: Image
/// Category: visualize /// Category: visualize
#[element(Layout, LocalName, Figurable)] #[element(Layout, LocalName, Figurable)]