docs: build with typlite v0.14

This commit is contained in:
Myriad-Dreamin 2025-11-03 20:14:35 +08:00
parent 6ff6a930a6
commit 7168dc3efd
5 changed files with 35 additions and 35 deletions

View file

@ -34,9 +34,9 @@ It contains:
Language service (LSP) features:
- [Semantic highlighting](https://code.visualstudio.com/api/language-extensions/semantic-highlight-guide)
- The "semantic highlighting" is supplementary to ["syntax highlighting"](https://code.visualstudio.com/api/language-extensions/syntax-highlight-guide).
- The “semantic highlighting” is supplementary to [“syntax highlighting”](https://code.visualstudio.com/api/language-extensions/syntax-highlight-guide).
- [Code actions](https://code.visualstudio.com/api/language-extensions/programmatic-language-features#provide-code-actions)
- Also known as "quick fixes" or "refactorings".
- Also known as “quick fixes” or “refactorings”.
- [Formatting (Reformatting)](https://code.visualstudio.com/api/language-extensions/programmatic-language-features#format-source-code-in-an-editor)
- Provide the user with support for formatting whole documents, using [typstfmt](https://github.com/astrale-sharp/typstfmt) or [typstyle](https://github.com/Enter-tainer/typstyle).
- [Document highlight](https://code.visualstudio.com/api/language-extensions/programmatic-language-features#highlight-all-occurrences-of-a-symbol-in-a-document)
@ -47,23 +47,23 @@ Language service (LSP) features:
- [Document links](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_documentLink)
- Renders path or link references in the document, such as `image("path.png")` or `bibliography(style: "path.csl")`.
- [Document symbols](https://code.visualstudio.com/docs/getstarted/userinterface#_outline-view)
- Also known as "document outline" or "table of contents" _in Typst_.
- Also known as “document outline” or “table of contents” _in Typst_.
- [Folding ranges](https://burkeholland.gitbook.io/vs-code-can-do-that/exercise-3-navigation-and-refactoring/folding-sections)
- You can collapse code/content blocks and headings.
- [Goto definitions](https://code.visualstudio.com/api/language-extensions/programmatic-language-features#show-definitions-of-a-symbol)
- Right-click on a symbol and select "Go to Definition".
- Right-click on a symbol and select “Go to Definition”.
- Or ctrl+click on a symbol.
- [References](https://code.visualstudio.com/api/language-extensions/programmatic-language-features#find-all-references-to-a-symbol)
- Right-click on a symbol and select "Go to References" or "Find References".
- Right-click on a symbol and select “Go to References” or “Find References”.
- Or ctrl+click on a symbol.
- [Hover tips](https://code.visualstudio.com/api/language-extensions/programmatic-language-features#show-hovers)
- Also known as "hovering tooltip".
- Also known as “hovering tooltip”.
- Render docs according to [tidy](https://github.com/Mc-Zen/tidy) style.
- [Inlay hints](https://www.jetbrains.com/help/idea/inlay-hints.html)
- Inlay hints are special markers that appear in the editor and provide you with additional information about your code, like the names of the parameters that a called method expects.
- [Color Provider](https://code.visualstudio.com/api/language-extensions/programmatic-language-features#show-color-decorators)
- View all inlay colorful label for color literals in your document.
- Change the color literal's value by a color picker or its code presentation.
- Change the color literals value by a color picker or its code presentation.
- [Code Lens](https://code.visualstudio.com/blogs/2017/02/12/code-lens-roundup)
- Should give contextual buttons along with code. For example, a button for exporting your document to various formats at the start of the document.
- [Rename symbols and embedded paths](https://code.visualstudio.com/api/language-extensions/programmatic-language-features#rename-symbols)
@ -71,7 +71,7 @@ Language service (LSP) features:
- [Workspace Symbols](https://code.visualstudio.com/api/language-extensions/programmatic-language-features#show-all-symbol-definitions-in-folder)
- [Code Action](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/developer/devenv-code-actions)
- Increasing/Decreasing heading levels.
- Turn equation into "inline", "block" or "multiple-line block" styles.
- Turn equation into “inline”, “block” or “multiple-line block” styles.
- [experimental/onEnter](https://github.com/rust-lang/rust-analyzer/blob/master/docs/dev/lsp-extensions.md#on-enter)
- <kbd>
@ -100,7 +100,7 @@ Extra features:
- Also compiles to SVG, PNG, HTML, Markdown, Text, and other formats by commands, vscode tasks, or code lenses.
- Provides test, benchmark, coverage collecting on documents and modules. Check [Docs: Testing Features](https://myriad-dreamin.github.io/tinymist/feature/testing.html).
- Provides builtin linting. Check [Docs: Linting Features](https://myriad-dreamin.github.io/tinymist/feature/linting.html).
- Provides a status bar item to show the current document's compilation status and words count.
- Provides a status bar item to show the current documents compilation status and words count.
- [Editor tools](/tools/editor-tools/):
- View a list of templates in template gallery. (`tinymist.showTemplateGallery`)
- Click a button in template gallery to initialize a new project with a template. (`tinymist.initTemplate` and `tinymist.initTemplateInPlace`)
@ -108,7 +108,7 @@ Extra features:
## Versioning and Release Cycle
Tinymist's versions follow the [Semantic Versioning](https://semver.org/) scheme, in format of `MAJOR.MINOR.PATCH`. Besides, tinymist follows special rules for the version number:
Tinymists versions follow the [Semantic Versioning](https://semver.org/) scheme, in format of `MAJOR.MINOR.PATCH`. Besides, tinymist follows special rules for the version number:
- If a version is suffixed with `-rcN` (<picture>
@ -136,7 +136,7 @@ Follow the instructions to enable tinymist in your favorite editor.
## Installing Regular/Nightly Prebuilds from GitHub
Note: if you are not knowing what is a regular/nightly release, please don't follow this section.
Note: if you are not knowing what is a regular/nightly release, please dont follow this section.
Besides published releases specific for each editors, you can also download the latest regular/nightly prebuilts from GitHub and install them manually.
@ -195,18 +195,18 @@ We are planning to implement the following features in typst v0.14.0 or spare ti
- Periscope renderer: It is disabled since vscode reject to render SVGs containing foreignObjects.
- Inlay hint: It is disabled _by default_ because of performance issues.
- Find references of dictionary fields and named function arguments.
- Improve symbol view's appearance.
- Improve symbol views appearance.
- Improve package view.
- Navigate to symbols by clicking on the symbol name in the view.
- Automatically locate the symbol item in the view when viewing local documentation.
- Remember the recently invoked package commands, e.g. "Open Docs of @preview/cetz:0.3.1", "Open directory of @preview/touying:0.5.3".
- Remember the recently invoked package commands, e.g. “Open Docs of @preview/cetz:0.3.1”, “Open directory of @preview/touying:0.5.3”.
- Improve label view.
- Group labels.
- Search labels.
- Keep (persist) group preferences.
- Improve Typst Preview.
- Pin drop-down: Set the file to preview in the drop-down for clients that doesn't support passing arguments to the preview command.
- Render in web worker (another thread) to reduce overhead on the electron's main thread.
- Pin drop-down: Set the file to preview in the drop-down for clients that doesnt support passing arguments to the preview command.
- Render in web worker (another thread) to reduce overhead on the electrons main thread.
- Spell checking: There is already a branch but no suitable (default) spell checking library is found.
- [typos](https://github.com/crate-ci/typos) is great for typst. [harper](https://github.com/Automattic/harper) looks promise.
@ -218,7 +218,7 @@ Please read the [CONTRIBUTING.md](CONTRIBUTING.md) file for contribution guideli
## Sponsoring
Tinymist thrives on community love and remains proudly independent. While we don't accept direct project funding, we warmly welcome support for our maintainers' personal efforts. Please go to [Maintainers Page](/MAINTAINERS.md) and [Contributors Page](https://github.com/Myriad-Dreamin/tinymist/graphs/contributors) and find their personal pages for more information. It is also welcomed to directly ask questions about sponsoring on the [GitHub Issues](https://github.com/Myriad-Dreamin/tinymist/issues/new).
Tinymist thrives on community love and remains proudly independent. While we dont accept direct project funding, we warmly welcome support for our maintainers personal efforts. Please go to [Maintainers Page](/MAINTAINERS.md) and [Contributors Page](https://github.com/Myriad-Dreamin/tinymist/graphs/contributors) and find their personal pages for more information. It is also welcomed to directly ask questions about sponsoring on the [GitHub Issues](https://github.com/Myriad-Dreamin/tinymist/issues/new).
## Acknowledgements

View file

@ -67,7 +67,7 @@ You can find all syntatical labels in the workspaces in the [_Label View_](#labe
### Outline View
You can get the document outline in the [_Outline View_](#outline-view) if [_Preview State_](#preview-state) is enabled. The outline is strictly same as the outline that will show up in the PDF document. This is different from the LSP's syntax outline which shows language syntax structure in the current opened document.
You can get the document outline in the [_Outline View_](#outline-view) if [_Preview State_](#preview-state) is enabled. The outline is strictly same as the outline that will show up in the PDF document. This is different from the LSPs syntax outline which shows language syntax structure in the current opened document.
## Tools

View file

@ -33,7 +33,7 @@ You should perform following steps to make a release PR with name in format of `
Before release, you should determine the version number to release.
Tinymist's versions follow the [Semantic Versioning](https://semver.org/) scheme, in format of `MAJOR.MINOR.PATCH`. Besides, tinymist follows special rules for the version number:
Tinymists versions follow the [Semantic Versioning](https://semver.org/) scheme, in format of `MAJOR.MINOR.PATCH`. Besides, tinymist follows special rules for the version number:
- If a version is suffixed with `-rcN` (<picture>

View file

@ -117,11 +117,11 @@ end, {})
> [!NOTE]
> > For Neovim prior to v0.9.5, `os.execute` can be used instead. This is not suggested. See [Issue #1606](https://github.com/Myriad-Dreamin/tinymist/issues/1606) for more information.
Make sure to change `exportPdf` to "onType" or "onSave".
Make sure to change `exportPdf` to “onType” or “onSave”.
### Working with Multiple-Files Projects
Tinymist cannot know the main file of a multiple-files project if you don't tell it explicitly. This causes the well-known label error when editing the `/sub.typ` file in a project like that:
Tinymist cannot know the main file of a multiple-files project if you dont tell it explicitly. This causes the well-known label error when editing the `/sub.typ` file in a project like that:
```typ
// in file: /sub.typ
@ -168,7 +168,7 @@ vim.lsp.buf.execute_command({ command = 'tinymist.pinMain', arguments = { vim.ap
vim.lsp.buf.execute_command({ command = 'tinymist.pinMain', arguments = { vim.v.null } })
```
It also doesn't remember the pinned main file across sessions, so you may need to run the command again after restarting Neovim.
It also doesnt remember the pinned main file across sessions, so you may need to run the command again after restarting Neovim.
This could be improved in the future.

View file

@ -37,7 +37,7 @@ To initialize a Typst project:
### Configuring LSP-Enhanced Formatters
1. Open settings.
2. Search for "Tinymist Formatter" and modify the value.
2. Search for “Tinymist Formatter” and modify the value.
- Use `"formatterMode": "typstyle"` for [typstyle](https://github.com/Enter-tainer/typstyle).
- Use `"formatterMode": "typstfmt"` for [typstfmt](https://github.com/astrale-sharp/typstfmt).
@ -54,15 +54,15 @@ Tips: to enable formatting on save, you should add extra settings for typst lang
### Configuring Linter
1. Open settings.
2. Search for "Tinymist Lint" and modify the value.
1. Toggle "Enabled" to enable or disable the linter.
2. Change "When" to configure when the linter runs.
2. Search for “Tinymist Lint” and modify the value.
1. Toggle “Enabled” to enable or disable the linter.
2. Change “When” to configure when the linter runs.
- (Default) `onSave` run linting when you save the file.
- `onType` run linting as you type.
### Configuring/Using Tinymists Activity Bar (Sidebar)
If you dont like the activity bar, you can right-click on the activity bar and uncheck "Tinymist" to hide it.
If you dont like the activity bar, you can right-click on the activity bar and uncheck “Tinymist” to hide it.
#### Symbol View
@ -123,8 +123,8 @@ To configure path to search fonts:
1. Open settings.
- File -\> Preferences -\> Settings (Linux, Windows).
- Code -\> Preferences -\> Settings (Mac).
2. Search for "Tinymist Font Paths" for providing paths to search fonts order-by-order.
3. Search for "Tinymist System Fonts" for disabling system fonts to be searched, which is useful for reproducible rendering your PDF documents.
2. Search for “Tinymist Font Paths” for providing paths to search fonts order-by-order.
3. Search for “Tinymist System Fonts” for disabling system fonts to be searched, which is useful for reproducible rendering your PDF documents.
4. Reload the window or restart the vscode editor to make the settings take effect.
**Note:** you must provide absolute paths.
@ -136,14 +136,14 @@ To configure path to search fonts:
To configure the root path resolved for Typst compiler:
1. Open settings.
2. Search for "Tinymist Root Path" and modify the value.
2. Search for “Tinymist Root Path” and modify the value.
3. Reload the window or restart the vscode editor to make the settings take effect. **Note:** you must provide absolute paths.
### Managing Local Packages
1. Use `Typst: Create Typst Local Package` command to create a local package.
2. Use `Typst: Open Typst Local Package` command to open a local package.
3. View and manage a list of available local packages in the "PACKAGE" view in the activity bar.
3. View and manage a list of available local packages in the “PACKAGE” view in the activity bar.
### Compiling PDF
@ -158,8 +158,8 @@ To find a way to compile PDF:
To configure when PDFs are compiled:
1. Open settings.
2. Search for "Tinymist Export PDF".
3. Change the "Export PDF" setting.
2. Search for “Tinymist Export PDF”.
3. Change the “Export PDF” setting.
- `onSave` makes a PDF after saving the Typst file.
- `onType` makes PDF files live, as you type.
- `never` disables PDF compilation.
@ -168,8 +168,8 @@ To configure when PDFs are compiled:
To configure where PDFs are saved:
1. Open settings.
2. Search for "Tinymist Output Path".
3. Change the "Output Path" setting. This is the path pattern to store artifacts, you can use `$root` or `$dir` or `$name` to do magic configuration
2. Search for “Tinymist Output Path”.
3. Change the “Output Path” setting. This is the path pattern to store artifacts, you can use `$root` or `$dir` or `$name` to do magic configuration
- e.g. `$root/$dir/$name` (default) for `$root/path/to/main.pdf`.
- e.g. `$root/target/$dir/$name` for `$root/target/path/to/main.pdf`.
- e.g. `$root/target/foo` for `$root/target/foo.pdf`. This will ensure that the output is always output to `target/foo.pdf`.
@ -194,7 +194,7 @@ You can pin a main file by command.
- Use command `Typst Unpin Main` (tinymist.unpinMain) to unset the main file.
> [!NOTE]
> > `tinymist.pinMain` is a stateful command, and tinymist doesn't remember it between sessions (closing and opening the editor).
> > `tinymist.pinMain` is a stateful command, and tinymist doesnt remember it between sessions (closing and opening the editor).
### Passing Extra CLI Arguments