Skip to content
This repository has been archived by the owner on Nov 7, 2024. It is now read-only.

Commit

Permalink
chore: bump to v0.6.4 (#73)
Browse files Browse the repository at this point in the history
  • Loading branch information
Enter-tainer authored Aug 6, 2023
1 parent a208689 commit f1a85dc
Show file tree
Hide file tree
Showing 6 changed files with 27 additions and 8 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "typst-preview"
version = "0.6.3"
version = "0.6.4"
authors = ["The Typst Project Developers"]
edition = "2021"

Expand Down
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Preview your Typst files in vscode instantly!

Install this extension from [marketplace](https://marketplace.visualstudio.com/items?itemName=mgt19937.typst-preview), open command palette (Ctrl+Shift+P), and type `>Typst Preview:`.

https://github.com/Enter-tainer/typst-preview-vscode/assets/25521218/600529ce-8f42-4c2f-a224-b6b73e6ad017
https://github.com/Enter-tainer/typst-preview/assets/25521218/600529ce-8f42-4c2f-a224-b6b73e6ad017

This repo contains:
- the native part of the extension, in rust
Expand All @@ -22,6 +22,10 @@ The extension watches for file changes, and incrementally compile your document

With all these techniques, we can achieve instant preview on type.

## Use without VSCode

You can use the binary `typst-preview` as a standalone typst preview server. It can be used to preview your document in browser. For example: `typst-preview ./assets/demo/main.typ --open-in-browser --partial-rendering`. This should be useful if you don't use VSCode but still want to experience the low latency preview.

## Acknowledgements

- [typst.ts](https://github.com/Myriad-Dreamin/typst.ts): typst.ts provide incremental svg export.
Expand Down
7 changes: 7 additions & 0 deletions addons/vscode/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,3 +94,10 @@ Add preview button
## v0.6.3

- Fix #13, #63: Now ctrl+wheel zoom should zoom the content to the cursor position. And when the cursor is not within the document, the zoom sill works.

## v0.6.4

- Rename to Typst Preview.
- Add page level partial rendering. This should improve performance on long document. This is an experimental feature and is disabled by default. You can enable it by setting `typst-preview.partialRendering` to `true`.
- The binary `typst-preview` now can be used as a standalone typst server. You can use it to preview your document in browser. For example: `typst-preview ./assets/demo/main.typ --open-in-browser --partial-rendering`
- Fix #70: now you can launch many preview instances at the same time.
14 changes: 11 additions & 3 deletions addons/vscode/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# [Typst Preview VSCode](https://github.com/Enter-tainer/typst-preview-vscode)
# [Typst Preview VSCode](https://github.com/Enter-tainer/typst-preview)

Preview your Typst files in vscode instantly!

Expand All @@ -12,18 +12,19 @@ Install this extension from [marketplace](https://marketplace.visualstudio.com/i

![demo](demo.png)

https://github.com/Enter-tainer/typst-preview-vscode/assets/25521218/600529ce-8f42-4c2f-a224-b6b73e6ad017
https://github.com/Enter-tainer/typst-preview/assets/25521218/600529ce-8f42-4c2f-a224-b6b73e6ad017

## Extension Settings

- `typst-preview.executable`: The executable path of typst-ws. Typically you don't need to change this because we already bundle typst-ws within the extension for all major platforms.
- `typst-preview.fontPaths`: Absolute path to a directory or file containing font assets inaddition to the default font search paths.
- `typst-preview.refresh`: When to refresh the preview. Refresh preview when the document is saved or when the document is changed. Possible values are `onType` and `onSave`. Default is `onType`.
- `typst-preview.scrollSync`: Whether to sync the preview position with the cursor. Default is `onSelectionChange`.
- `typst-preview.partialRendering`: Whether to render only the visible part of the document. This provides better performance on long document. Default is `false`. This is an experimental feature.

## Known Issues

See [issues](https://github.com/Enter-tainer/typst-preview-vscode/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) on GitHub.
See [issues](https://github.com/Enter-tainer/typst-preview/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) on GitHub.

## Release Notes

Expand Down Expand Up @@ -116,3 +117,10 @@ Add preview button
### v0.6.3

- Fix #13, #63: Now ctrl+wheel zoom should zoom the content to the cursor position. And when the cursor is not within the document, the zoom sill works.

### v0.6.4

- Rename to Typst Preview.
- Add page level partial rendering. This should improve performance on long document. This is an experimental feature and is disabled by default. You can enable it by setting `typst-preview.partialRendering` to `true`.
- The binary `typst-preview` now can be used as a standalone preview server. You can use it to preview your document in browser. For example: `typst-preview ./assets/demo/main.typ --open-in-browser --partial-rendering`
- Fix #70: now you can launch many preview instances at the same time.
4 changes: 2 additions & 2 deletions addons/vscode/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
"license": "MIT",
"repository": {
"type": "git",
"url": "https://github.com/Enter-tainer/typst-preview-vscode"
"url": "https://github.com/Enter-tainer/typst-preview"
},
"version": "0.6.3",
"version": "0.6.4",
"engines": {
"vscode": "^1.77.0"
},
Expand Down

0 comments on commit f1a85dc

Please sign in to comment.