summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLaurenz Stampfl <47084093+LaurenzV@users.noreply.github.com>2023-05-19 14:41:33 +0200
committerGitHub <noreply@github.com>2023-05-19 14:41:33 +0200
commitf9ab828e2992f795b57fe03ad10d498b315f7e7d (patch)
tree46be7eb02052261c5776b3f96f51eaa1a2a7d9d8
parent85ea0350e4182d5fcf46b3bab3f48ee0a3587d2a (diff)
Add note about embedding svg images (#1243)
-rw-r--r--library/src/visualize/image.rs6
1 files changed, 6 insertions, 0 deletions
diff --git a/library/src/visualize/image.rs b/library/src/visualize/image.rs
index 071aab21..c38f5e78 100644
--- a/library/src/visualize/image.rs
+++ b/library/src/visualize/image.rs
@@ -11,6 +11,10 @@ use crate::text::families;
///
/// 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
/// #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
/// Category: visualize
#[element(Layout, LocalName, Figurable)]