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

Update directories in architecture docs (#5214)

Browse Source
This commit is contained in:
Niklas Eicker 2024-10-18 09:55:19 +02:00 committed by GitHub
parent e0d809680a
commit ebb60001d8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/dev/architecture.md
View File

@ -11,19 +11,16 @@ 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-docs`: Generates the content of the official
[documentation][docs] from the content of the `docs` folder and the inline
Rust documentation. Only generates the content and structure, not the concrete
HTML (that part is currently closed source).
- `crates/typst-ide`: Exposes IDE functionality. - `crates/typst-ide`: Exposes IDE functionality.
- `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-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.
- `docs`: Source files for longer-form parts of the documentation. Individual - `docs`: Generates the content of the official
elements and functions are documented inline with the Rust source code. [documentation][docs] from markdown files and the inline
- `assets`: Fonts and files used for tests and the documentation. Rust documentation. Only generates the content and structure, not the concrete
HTML (that part is currently closed source).
- `tests`: Integration tests for Typst compilation. - `tests`: Integration tests for Typst compilation.
- `tools`: Tooling for development. - `tools`: Tooling for development.