Skip to content

Commit 8cb41af

Browse files
authored
docs: add deprecation notice in readme (#375)
1 parent 8a8419b commit 8cb41af

File tree

1 file changed

+17
-0
lines changed
  • contrib/typst-preview/editors/vscode

1 file changed

+17
-0
lines changed

contrib/typst-preview/editors/vscode/README.md

+17
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,20 @@
1+
# [DEPRECATION NOTICE] Typst preivew extension has been integrated into [tinymist](https://github.com/Myriad-Dreamin/tinymist)
2+
3+
We recommend all users migrate to tinymist for the following benefits:
4+
5+
- More centralized resource management
6+
- Reduced redundancy and lower resource usage
7+
- Easier updates and maintenance
8+
9+
This repository will no longer be updated in future. All development will move to tinymist. Thank you for your support and understanding!
10+
11+
- We still maintain the typst-preview extension for a while in a best effort way.
12+
- The lazy people can continue using their setting, as all old things are still working.
13+
- This respect people who love minimal env, like a treesitter plugin plus preview.
14+
- Tinymist will ensure compatibility to typst-preview as much as possible.
15+
- for vscode users: uninstall the preview extension and install the tinymist extension.
16+
- for standalone cli users: `typst-preview -> tinymist preview`
17+
118
# [Typst Preview VSCode](https://github.com/Enter-tainer/typst-preview)
219

320
Preview your Typst files in vscode instantly!

0 commit comments

Comments
 (0)