caisin/typst
1
0
Fork 0
mirror of https://github.com/typst/typst synced 2025-05-14 04:56:26 +08:00
Code Issues Packages Projects Releases Wiki Activity

architecture.md: Update crate list (#5487)

Browse Source
This commit is contained in:
+merlan #flirora 2024-11-29 04:20:35 -05:00 committed by GitHub
parent 89d96c623d
commit 9ce40cb91f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/dev/architecture.md
View File

@ -11,12 +11,20 @@ Let's start with a broad overview of the directories in this repository:
and library. and library.
- `crates/typst-cli`: Typst's command line interface. This is a relatively small - `crates/typst-cli`: Typst's command line interface. This is a relatively small
layer on top of the compiler and the exporters. layer on top of the compiler and the exporters.
- `crates/typst-eval`: The interpreter for the Typst language.
- `crates/typst-ide`: Exposes IDE functionality. - `crates/typst-ide`: Exposes IDE functionality.
- `crates/typst-kit`: Contains various default implementation of
functionality used in `typst-cli`.
- `crates/typst-layout`: Typst's layout engine.
- `crates/typst-library`: Typst's standard library.
- `crates/typst-macros`: Procedural macros for the compiler. - `crates/typst-macros`: Procedural macros for the compiler.
- `crates/typst-pdf`: The PDF exporter. - `crates/typst-pdf`: The PDF exporter.
- `crates/typst-realize`: Typst's realization subsystem.
- `crates/typst-render`: A renderer for Typst frames. - `crates/typst-render`: A renderer for Typst frames.
- `crates/typst-svg`: The SVG exporter. - `crates/typst-svg`: The SVG exporter.
- `crates/typst-syntax`: Home to the parser and syntax tree definition. - `crates/typst-syntax`: Home to the parser and syntax tree definition.
- `crates/typst-timing`: Performance timing for Typst.
- `crates/typst-utils`: Utilities for Typst.
- `docs`: Generates the content of the official - `docs`: Generates the content of the official
[documentation][docs] from markdown files and the inline [documentation][docs] from markdown files and the inline
Rust documentation. Only generates the content and structure, not the concrete Rust documentation. Only generates the content and structure, not the concrete
@ -30,8 +38,8 @@ The source-to-PDF compilation process of a Typst file proceeds in four phases.
1. **Parsing:** Turns a source string into a syntax tree. 1. **Parsing:** Turns a source string into a syntax tree.
2. **Evaluation:** Turns a syntax tree and its dependencies into content. 2. **Evaluation:** Turns a syntax tree and its dependencies into content.
4. **Layout:** Layouts content into frames. 3. **Layout:** Layouts content into frames.
5. **Export:** Turns frames into an output format like PDF or a raster graphic. 4. **Export:** Turns frames into an output format like PDF or a raster graphic.
The Typst compiler is _incremental:_ Recompiling a document that was compiled The Typst compiler is _incremental:_ Recompiling a document that was compiled
previously is much faster than compiling from scratch. Most of the hard work is previously is much faster than compiling from scratch. Most of the hard work is