Skip to content

Commit

Permalink
docs: update roadmap (typst v0.13.0+) (#876)
Browse files Browse the repository at this point in the history
* docs: update roadmap (typst v0.13.0+)

* fix: wording
  • Loading branch information
Myriad-Dreamin authored Nov 21, 2024
1 parent 67e659a commit a2cf51a
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 20 deletions.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,12 +123,30 @@ Nightly Channel:

## Roadmap

The development in typst v0.12.0 has been finished. We'll slow down for a while to catch regressions and bugs by changes. We are also planning to implement the following features in typst v0.13.0 or spare time in weekend:

- Spell checking: There is already a branch but no suitable (default) spell checking library is found.
- Type checking: complete the type checker.
- Static Linter: linting code statically according to feedback of the type checker and succeeding code analysis.
- 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.
- Go to definition of dictionary fields and named function arguments.
- A reliable way of configuring projects's entry files and files to export across editors. See [GitHub Issue 530.](https://github.com/Myriad-Dreamin/tinymist/issues/530)
- Improve symbol view's 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".
- Improve label view.
- Group labels.
- Search labels.
- Keep (persist) group preferences.
- Improve Typst Preview.
- Browsing mode: if no main file is specified, the preview will be in browsing mode and use the recently focused file as the main.
- 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.

If you are interested by any above features, please feel free to send Issues to discuss or PRs to implement to [GitHub.](https://github.com/Myriad-Dreamin/tinymist)

## Contributing

Expand Down
20 changes: 19 additions & 1 deletion docs/tinymist/introduction.typ
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,30 @@ Nightly Channel:

== Roadmap

The development in typst v0.12.0 has been finished. We'll slow down for a while to catch regressions and bugs by changes. We are also planning to implement the following features in typst v0.13.0 or spare time in weekend:

- Spell checking: There is already a branch but no suitable (default) spell checking library is found.
- Type checking: complete the type checker.
- Static Linter: linting code statically according to feedback of the type checker and succeeding code analysis.
- 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.
- Go to definition of dictionary fields and named function arguments.
- A reliable way of configuring projects's entry files and files to export across editors. See #link("https://github.com/Myriad-Dreamin/tinymist/issues/530")[GitHub Issue 530.]
- Improve symbol view's 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".
- Improve label view.
- Group labels.
- Search labels.
- Keep (persist) group preferences.
- Improve Typst Preview.
- Browsing mode: if no main file is specified, the preview will be in browsing mode and use the recently focused file as the main.
- 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.

If you are interested by any above features, please feel free to send Issues to discuss or PRs to implement to #link("https://github.com/Myriad-Dreamin/tinymist")[GitHub.]

== Contributing

Expand Down
19 changes: 1 addition & 18 deletions editors/emacs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,24 +61,7 @@ For example, if you want to export PDF on save:

```el
(setq-default eglot-workspace-configuration
'(:exportPdf "onSave"))
```

Here is an example for both configuring `pylsp` and `tinymist`

```el
(setq-default eglot-workspace-configuration
'(:pylsp (:plugins (:ruff (:enabled t)))
:exportPdf "onSave"))
```

NOTE: Currently, `tinymist` doesn't support having its name as the top-level
configuration entry, so the following configuration won't work:

```el
(setq-default eglot-workspace-configuration
'(:pylsp (:plugins (:ruff (:enabled t)))
:tinymist (:exportPdf "onSave")))
'(:tinymist (:exportPdf "onSave")))
```

You can also have configuration per directory. Be sure to look at the
Expand Down

0 comments on commit a2cf51a

Please sign in to comment.