diff options
| author | Niklas Eicker <git@nikl.me> | 2024-10-18 09:55:19 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-10-18 07:55:19 +0000 |
| commit | ebb60001d8fa7ce7c2f824e8e2396b8d485bbb48 (patch) | |
| tree | 14e21787d1e9ac3a61621033c25f2f044c29345c /docs/dev | |
| parent | e0d809680aed778443a4797bc044376dbe15347e (diff) | |
Update directories in architecture docs (#5214)
Diffstat (limited to 'docs/dev')
| -rw-r--r-- | docs/dev/architecture.md | 11 |
1 files changed, 4 insertions, 7 deletions
diff --git a/docs/dev/architecture.md b/docs/dev/architecture.md index 23c67c8a..2caa12b7 100644 --- a/docs/dev/architecture.md +++ b/docs/dev/architecture.md @@ -11,19 +11,16 @@ Let's start with a broad overview of the directories in this repository: and library. - `crates/typst-cli`: Typst's command line interface. This is a relatively small 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-macros`: Procedural macros for the compiler. - `crates/typst-pdf`: The PDF exporter. - `crates/typst-render`: A renderer for Typst frames. - `crates/typst-svg`: The SVG exporter. - `crates/typst-syntax`: Home to the parser and syntax tree definition. -- `docs`: Source files for longer-form parts of the documentation. Individual - elements and functions are documented inline with the Rust source code. -- `assets`: Fonts and files used for tests and the documentation. +- `docs`: Generates the content of the official + [documentation][docs] from markdown files and the inline + Rust documentation. Only generates the content and structure, not the concrete + HTML (that part is currently closed source). - `tests`: Integration tests for Typst compilation. - `tools`: Tooling for development. |