mirror of
https://github.com/typst/typst
synced 2025-07-28 06:47:53 +08:00
Compare commits
15 Commits
c35056e1f4
...
bccf16c643
Author | SHA1 | Date | |
---|---|---|---|
|
bccf16c643 | ||
|
b790c6d59c | ||
|
b1c79b50d4 | ||
|
4629ede020 | ||
|
a1c01dff7f | ||
|
941c3123af | ||
|
d45a621358 | ||
|
68bf10498f | ||
|
6e7049ba32 | ||
|
c98c72847d | ||
|
7eefc19441 | ||
|
8571158b50 | ||
|
2fbed47c3e | ||
|
eabedfc61c | ||
|
615ded766b |
2
.github/ISSUE_TEMPLATE/2-feature.yml
vendored
2
.github/ISSUE_TEMPLATE/2-feature.yml
vendored
@ -1,4 +1,4 @@
|
|||||||
name: 🪴 Compiler Feature Request
|
name: 🌻 Compiler Feature Request
|
||||||
description: For feature requests for the Typst compiler
|
description: For feature requests for the Typst compiler
|
||||||
title: Write a short and descriptive title!
|
title: Write a short and descriptive title!
|
||||||
labels:
|
labels:
|
||||||
|
@ -174,7 +174,10 @@ typst help watch
|
|||||||
```
|
```
|
||||||
|
|
||||||
If you prefer an integrated IDE-like experience with autocompletion and instant
|
If you prefer an integrated IDE-like experience with autocompletion and instant
|
||||||
preview, you can also check out [Typst's free web app][app].
|
preview, you can also check out our [free web app][app]. Alternatively, there is
|
||||||
|
a community-created language server called
|
||||||
|
[Tinymist](https://myriad-dreamin.github.io/tinymist/) which is integrated into
|
||||||
|
various editor extensions.
|
||||||
|
|
||||||
## Community
|
## Community
|
||||||
The main places where the community gathers are our [Forum][forum] and our
|
The main places where the community gathers are our [Forum][forum] and our
|
||||||
|
@ -6,7 +6,7 @@ use crate::foundations::{func, Array, Context, LocatableSelector, Value};
|
|||||||
|
|
||||||
/// Finds elements in the document.
|
/// Finds elements in the document.
|
||||||
///
|
///
|
||||||
/// The `query` functions lets you search your document for elements of a
|
/// The `query` function lets you search your document for elements of a
|
||||||
/// particular type or with a particular label. To use it, you first need to
|
/// particular type or with a particular label. To use it, you first need to
|
||||||
/// ensure that [context] is available.
|
/// ensure that [context] is available.
|
||||||
///
|
///
|
||||||
|
@ -340,7 +340,7 @@ pub struct PageElem {
|
|||||||
/// This content will overlay the page's body.
|
/// This content will overlay the page's body.
|
||||||
///
|
///
|
||||||
/// ```example
|
/// ```example
|
||||||
/// #set page(foreground: text(24pt)[🥸])
|
/// #set page(foreground: text(24pt)[🤓])
|
||||||
///
|
///
|
||||||
/// Reviewer 2 has marked our paper
|
/// Reviewer 2 has marked our paper
|
||||||
/// "Weak Reject" because they did
|
/// "Weak Reject" because they did
|
||||||
|
@ -625,7 +625,7 @@ pub struct TableVLine {
|
|||||||
/// cell(align: left)[🌴🚗],
|
/// cell(align: left)[🌴🚗],
|
||||||
/// cell(
|
/// cell(
|
||||||
/// inset: 0.06em,
|
/// inset: 0.06em,
|
||||||
/// text(1.62em)[🛖🌅🌊],
|
/// text(1.62em)[🏝️🌅🌊],
|
||||||
/// ),
|
/// ),
|
||||||
/// )
|
/// )
|
||||||
/// ```
|
/// ```
|
||||||
|
@ -797,7 +797,9 @@ impl Color {
|
|||||||
components
|
components
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns the constructor function for this color's space:
|
/// Returns the constructor function for this color's space.
|
||||||
|
///
|
||||||
|
/// Returns one of:
|
||||||
/// - [`luma`]($color.luma)
|
/// - [`luma`]($color.luma)
|
||||||
/// - [`oklab`]($color.oklab)
|
/// - [`oklab`]($color.oklab)
|
||||||
/// - [`oklch`]($color.oklch)
|
/// - [`oklch`]($color.oklch)
|
||||||
|
@ -33,8 +33,8 @@ collaborative editor and run Typst in your browser, no installation required.
|
|||||||
|
|
||||||
If you choose to use Typst on your computer instead, you can download the
|
If you choose to use Typst on your computer instead, you can download the
|
||||||
compiler as a single, small binary which any user can run, no root privileges
|
compiler as a single, small binary which any user can run, no root privileges
|
||||||
required. Unlike LaTeX, packages are downloaded when you first use them and
|
required. Packages are downloaded when you first use them and then cached
|
||||||
then cached locally, keeping your Typst installation lean. You can use your own
|
locally, keeping your Typst installation lean. You can use your own
|
||||||
editor and decide where to store your files with the local compiler.
|
editor and decide where to store your files with the local compiler.
|
||||||
|
|
||||||
## How do I create a new, empty document? { #getting-started }
|
## How do I create a new, empty document? { #getting-started }
|
||||||
@ -459,7 +459,7 @@ and their corresponding Typst functions.
|
|||||||
| LaTeX Package | Typst Alternative |
|
| LaTeX Package | Typst Alternative |
|
||||||
|:--------------------------------|:-------------------------------------------|
|
|:--------------------------------|:-------------------------------------------|
|
||||||
| graphicx, svg | [`image`] function |
|
| graphicx, svg | [`image`] function |
|
||||||
| tabularx | [`table`], [`grid`] functions |
|
| tabularx, tabularray | [`table`], [`grid`] functions |
|
||||||
| fontenc, inputenc, unicode-math | Just start writing! |
|
| fontenc, inputenc, unicode-math | Just start writing! |
|
||||||
| babel, polyglossia | [`text`]($text.lang) function: `[#set text(lang: "zh")]` |
|
| babel, polyglossia | [`text`]($text.lang) function: `[#set text(lang: "zh")]` |
|
||||||
| amsmath | [Math mode]($category/math) |
|
| amsmath | [Math mode]($category/math) |
|
||||||
@ -550,7 +550,7 @@ $ f(x) = (x + 1) / x $
|
|||||||
to include more than one value in a sub- or superscript, enclose their contents
|
to include more than one value in a sub- or superscript, enclose their contents
|
||||||
in parentheses: `{$x_(a -> epsilon)$}`.
|
in parentheses: `{$x_(a -> epsilon)$}`.
|
||||||
|
|
||||||
Since variables in math mode do not need to be prepended with a `#` or a `/`,
|
Since variables in math mode do not need to be prepended with a `#`,
|
||||||
you can also call functions without these special characters:
|
you can also call functions without these special characters:
|
||||||
|
|
||||||
```example
|
```example
|
||||||
@ -580,8 +580,8 @@ their call with a `#`. Nobody can stop you from using rectangles or emoji as
|
|||||||
your variables anymore:
|
your variables anymore:
|
||||||
|
|
||||||
```example
|
```example
|
||||||
$ sum^10_(🥸=1)
|
$ sum^10_(🤓=1)
|
||||||
#rect(width: 4mm, height: 2mm)/🥸
|
#rect(width: 4mm, height: 2mm)/🤓
|
||||||
= 🧠 maltese $
|
= 🧠 maltese $
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -242,7 +242,7 @@ fn category_page(resolver: &dyn Resolver, category: Category) -> PageModel {
|
|||||||
items.push(CategoryItem {
|
items.push(CategoryItem {
|
||||||
name: group.name.clone(),
|
name: group.name.clone(),
|
||||||
route: subpage.route.clone(),
|
route: subpage.route.clone(),
|
||||||
oneliner: oneliner(docs).into(),
|
oneliner: oneliner(docs),
|
||||||
code: true,
|
code: true,
|
||||||
});
|
});
|
||||||
children.push(subpage);
|
children.push(subpage);
|
||||||
@ -296,7 +296,7 @@ fn category_page(resolver: &dyn Resolver, category: Category) -> PageModel {
|
|||||||
items.push(CategoryItem {
|
items.push(CategoryItem {
|
||||||
name: name.into(),
|
name: name.into(),
|
||||||
route: subpage.route.clone(),
|
route: subpage.route.clone(),
|
||||||
oneliner: oneliner(func.docs().unwrap_or_default()).into(),
|
oneliner: oneliner(func.docs().unwrap_or_default()),
|
||||||
code: true,
|
code: true,
|
||||||
});
|
});
|
||||||
children.push(subpage);
|
children.push(subpage);
|
||||||
@ -306,7 +306,7 @@ fn category_page(resolver: &dyn Resolver, category: Category) -> PageModel {
|
|||||||
items.push(CategoryItem {
|
items.push(CategoryItem {
|
||||||
name: ty.short_name().into(),
|
name: ty.short_name().into(),
|
||||||
route: subpage.route.clone(),
|
route: subpage.route.clone(),
|
||||||
oneliner: oneliner(ty.docs()).into(),
|
oneliner: oneliner(ty.docs()),
|
||||||
code: true,
|
code: true,
|
||||||
});
|
});
|
||||||
children.push(subpage);
|
children.push(subpage);
|
||||||
@ -637,7 +637,7 @@ fn group_page(
|
|||||||
let item = CategoryItem {
|
let item = CategoryItem {
|
||||||
name: group.name.clone(),
|
name: group.name.clone(),
|
||||||
route: model.route.clone(),
|
route: model.route.clone(),
|
||||||
oneliner: oneliner(&group.details).into(),
|
oneliner: oneliner(&group.details),
|
||||||
code: false,
|
code: false,
|
||||||
};
|
};
|
||||||
|
|
||||||
@ -772,8 +772,24 @@ pub fn urlify(title: &str) -> EcoString {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// Extract the first line of documentation.
|
/// Extract the first line of documentation.
|
||||||
fn oneliner(docs: &str) -> &str {
|
fn oneliner(docs: &str) -> EcoString {
|
||||||
docs.lines().next().unwrap_or_default()
|
let paragraph = docs.split("\n\n").next().unwrap_or_default();
|
||||||
|
let mut depth = 0;
|
||||||
|
let mut period = false;
|
||||||
|
let mut end = paragraph.len();
|
||||||
|
for (i, c) in paragraph.char_indices() {
|
||||||
|
match c {
|
||||||
|
'(' | '[' | '{' => depth += 1,
|
||||||
|
')' | ']' | '}' => depth -= 1,
|
||||||
|
'.' if depth == 0 => period = true,
|
||||||
|
c if period && c.is_whitespace() && !docs[..i].ends_with("e.g.") => {
|
||||||
|
end = i;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
_ => period = false,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
EcoString::from(&docs[..end]).replace("\r\n", " ").replace("\n", " ")
|
||||||
}
|
}
|
||||||
|
|
||||||
/// The order of types in the documentation.
|
/// The order of types in the documentation.
|
||||||
|
@ -86,7 +86,7 @@ pub struct FuncModel {
|
|||||||
pub name: EcoString,
|
pub name: EcoString,
|
||||||
pub title: &'static str,
|
pub title: &'static str,
|
||||||
pub keywords: &'static [&'static str],
|
pub keywords: &'static [&'static str],
|
||||||
pub oneliner: &'static str,
|
pub oneliner: EcoString,
|
||||||
pub element: bool,
|
pub element: bool,
|
||||||
pub contextual: bool,
|
pub contextual: bool,
|
||||||
pub deprecation: Option<&'static str>,
|
pub deprecation: Option<&'static str>,
|
||||||
@ -139,7 +139,7 @@ pub struct TypeModel {
|
|||||||
pub name: &'static str,
|
pub name: &'static str,
|
||||||
pub title: &'static str,
|
pub title: &'static str,
|
||||||
pub keywords: &'static [&'static str],
|
pub keywords: &'static [&'static str],
|
||||||
pub oneliner: &'static str,
|
pub oneliner: EcoString,
|
||||||
pub details: Html,
|
pub details: Html,
|
||||||
pub constructor: Option<FuncModel>,
|
pub constructor: Option<FuncModel>,
|
||||||
pub scope: Vec<FuncModel>,
|
pub scope: Vec<FuncModel>,
|
||||||
|
@ -127,6 +127,10 @@
|
|||||||
checks = self'.checks;
|
checks = self'.checks;
|
||||||
inputsFrom = [ typst ];
|
inputsFrom = [ typst ];
|
||||||
|
|
||||||
|
buildInputs = with pkgs; [
|
||||||
|
rust-analyzer
|
||||||
|
];
|
||||||
|
|
||||||
packages = [
|
packages = [
|
||||||
# A script for quickly running tests.
|
# A script for quickly running tests.
|
||||||
# See https://github.com/typst/typst/blob/main/tests/README.md#making-an-alias
|
# See https://github.com/typst/typst/blob/main/tests/README.md#making-an-alias
|
||||||
|
Loading…
x
Reference in New Issue
Block a user