summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLaurenz <laurmaedje@gmail.com>2024-05-17 11:39:29 +0200
committerGitHub <noreply@github.com>2024-05-17 09:39:29 +0000
commit6a1a58a2d49d0e56c907018593aeaa97e7f58470 (patch)
treee4f41f8c860e7021a9ed71594767de46741321f8
parent00f7588755faac7982fda54371e3f29662010d5f (diff)
Mention that raw and equation syntax works in both markup and code mode (#4164)
-rw-r--r--crates/typst/src/text/raw.rs2
-rw-r--r--docs/reference/syntax.md10
2 files changed, 7 insertions, 5 deletions
diff --git a/crates/typst/src/text/raw.rs b/crates/typst/src/text/raw.rs
index ae7525be..1aa69fbf 100644
--- a/crates/typst/src/text/raw.rs
+++ b/crates/typst/src/text/raw.rs
@@ -59,6 +59,8 @@ type LineFn<'a> = &'a mut dyn FnMut(usize, Range<usize>, &mut Vec<Content>);
/// # Syntax
/// This function also has dedicated syntax. You can enclose text in 1 or 3+
/// backticks (`` ` ``) to make it raw. Two backticks produce empty raw text.
+/// This works both in markup and code.
+///
/// When you use three or more backticks, you can additionally specify a
/// language tag for syntax highlighting directly after the opening backticks.
/// Within raw blocks, everything (except for the language tag, if applicable)
diff --git a/docs/reference/syntax.md b/docs/reference/syntax.md
index 454dce16..9a7dc373 100644
--- a/docs/reference/syntax.md
+++ b/docs/reference/syntax.md
@@ -57,11 +57,11 @@ more about their syntax and usage.
## Math mode { #math }
Math mode is a special markup mode that is used to typeset mathematical
-formulas. It is entered by wrapping an equation in `[$]` characters. The
-equation will be typeset into its own block if it starts and ends with at least
-one space (e.g. `[$ x^2 $]`). Inline math can be produced by omitting the
-whitespace (e.g. `[$x^2$]`). An overview over the syntax specific to math mode
-follows:
+formulas. It is entered by wrapping an equation in `[$]` characters. This works
+both in markup and code. The equation will be typeset into its own block if it
+starts and ends with at least one space (e.g. `[$ x^2 $]`). Inline math can be
+produced by omitting the whitespace (e.g. `[$x^2$]`). An overview over the
+syntax specific to math mode follows:
| Name | Example | See |
| ---------------------- | ------------------------ | ------------------------ |