docs: minor updates (#345)

This commit is contained in:
Myriad-Dreamin 2024-06-26 16:40:21 +08:00 committed by GitHub
parent 39d6c0affe
commit eccfe42d1a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 10 additions and 5 deletions

View file

@ -69,11 +69,15 @@ Follow the instructions to enable tinymist in your favorite editor.
+ [VSCode](./editors/vscode/README.md)
+ [Zed](editors/zed/README.md)
## Documentation
See [Online Documentation](https://myriad-dreamin.github.io/tinymist/).
## Packaging
[![Packaging status](https://repology.org/badge/vertical-allrepos/tinymist.svg)](https://repology.org/project/tinymist/versions)
### Roadmap
## 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.
@ -87,7 +91,7 @@ After development for two months, most of the features are implemented. There ar
- Autocompletion for raw language tags.
- Improve symbol view's appearance.
### Contributing
## Contributing
Please read the [CONTRIBUTING.md](CONTRIBUTING.md) file for contribution guidelines.

View file

@ -1,4 +1,5 @@
#import "mod.typ": *
#import "@preview/cmarker:0.1.0": render as md
#show: book-page.with(title: "Tinymist Configurations")
@ -15,12 +16,12 @@
- Type: #config-type(cfg.type)
#if cfg.type == "array" [
- Items: #raw(cfg.items.type)
- Description: #eval(cfg.items.description, mode: "markup")
- Description: #md(cfg.items.description)
]
- Description: #eval(cfg.description, mode: "markup")
- Description: #md(cfg.description)
#if cfg.at("enum", default: none) != none [
- Valid values: #for (i, item) in cfg.enum.enumerate() [
- #raw(item): #if "enumDescriptions" in cfg { eval(cfg.enumDescriptions.at(i), mode: "markup") }
- #raw(item): #if "enumDescriptions" in cfg { md(cfg.enumDescriptions.at(i)) }
]
]
#if type(cfg.default) == str {