language-servers/tinymist
1
0
Fork 0
mirror of https://github.com/Myriad-Dreamin/tinymist.git synced 2025-08-04 10:18:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

docs: add documentation about installing nightly prebuilts (#480)

Browse source
This commit is contained in:
Myriad-Dreamin 2024-07-30 18:47:45 +08:00 • committed by GitHub
parent acd22b71a5
commit d2689a120e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 34 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

18
docs/tinymist/introduction.typ
View file

@ -64,6 +64,12 @@ Extra features:
- Click a button in template gallery to initialize a new project with a template. (`tinymist.initTemplate` and `tinymist.initTemplateInPlace`)
- Trace execution in current document. (`tinymist.profileCurrentFile`)
== Release Cycle
Tinymist follows the #link("https://semver.org/")[Semantic Versioning] scheme. The version number is in the format of `MAJOR.MINOR.PATCH`. The release cycle is as follows:
- If there is a typst version update, a new major or minor version will be released intermediately. This means tinymist will always align the minor version with typst.
- If there is at least a bug or feature added this week, a new patch version will be released.
== Installation
Follow the instructions to enable tinymist in your favorite editor.
@ -72,6 +78,17 @@ Follow the instructions to enable tinymist in your favorite editor.
+ #link("https://github.com/Myriad-Dreamin/tinymist/tree/main/editors/vscode/README.md")[VSCode]
+ #link("https://github.com/Myriad-Dreamin/tinymist/tree/main/editors/zed/README.md")[Zed]
== Installing Regular/Nightly Prebuilds from GitHub
Note: if you are not knowing what is a regular/nightly release, please don't 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.
- Regular prebuilts can be found in #link("https://github.com/Myriad-Dreamin/tinymist/releases")[GitHub Releases].
- Nightly prebuilts can be found in #link("https://github.com/Myriad-Dreamin/tinymist/actions")[GitHub Actions]. For example, if you are seeking a nightly release for the featured #link("https://github.com/Myriad-Dreamin/tinymist/pull/468")[PR: build: bump version to 0.11.17-rc1], you could click and go to the #link("https://github.com/Myriad-Dreamin/tinymist/actions/runs/10120639466")[action page] run for the related commits and download the artifacts.
To install extension file (the file with `.vsix` extension) manually, please #kbd("Ctrl+Shift+X") in the editor window and drop the downloaded vsix file into the opended extensions view.
== Documentation
See #link("https://myriad-dreamin.github.io/tinymist/")[Online Documentation].
@ -86,7 +103,6 @@ See #link("https://myriad-dreamin.github.io/tinymist/")[Online Documentation].
),
)
== Roadmap
After development for two months, most of the features are implemented. There are still some features to be implemented, but I would like to leave them in typst v0.12.0. I'll also pick some of them to implement on my weekends. Also please feel free to contribute if you are interested in the following features.