docs: update readme for publish

README.md

@@ -23,19 +23,21 @@ Language service (LSP) features:
 - [Goto definitions](https://code.visualstudio.com/api/language-extensions/programmatic-language-features#show-definitions-of-a-symbol)
   - Right-click on a symbol and select "Go to Definition".
   - Or ctrl+click on a symbol.
-- [Goto declarations](https://code.visualstudio.com/api/language-extensions/programmatic-language-features#find-all-references-to-a-symbol)
-  - Also known as "find all references".
+<!-- - [Goto declarations](https://code.visualstudio.com/api/language-extensions/programmatic-language-features#find-all-references-to-a-symbol)
+  - Also known as "find all references". -->
 - [Hover tips](https://code.visualstudio.com/api/language-extensions/programmatic-language-features#show-hovers)
   - Also known as "hovering tooltip".
 - [Inlay hints](https://www.jetbrains.com/help/idea/inlay-hints.html)
   - Inlay hints are special markers that appear in the editor and provide you with additional information about your code, like the names of the parameters that a called method expects.
+- [Code Lens](https://code.visualstudio.com/blogs/2017/02/12/code-lens-roundup)
+  - Should give contextual buttons along with code. For example, a button for exporting your document to various formats at the start of the document.
 - [Rename symbols](https://code.visualstudio.com/api/language-extensions/programmatic-language-features#rename-symbols)
 - [Help with function and method signatures](https://code.visualstudio.com/api/language-extensions/programmatic-language-features#help-with-function-and-method-signatures)
 - [Workspace Symbols](https://code.visualstudio.com/api/language-extensions/programmatic-language-features#show-all-symbol-definitions-in-folder)
 
 Extra features:
 
-- Compiles to PDF on save (configurable to as-you-type, or can be disabled)
+- Compiles to PDF on save (configurable to as-you-type, or other options)
 
 ## Installation
 
@@ -44,4 +46,4 @@ Follow the instructions to enable tinymist in your favorite editor.
 
 ## Acknowledgements
 
-- It is developed based on [typst-lsp](https://github.com/nvarner/typst-lsp)
+- Partially code is inherited from [typst-lsp](https://github.com/nvarner/typst-lsp)

editors/vscode/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Change Log
+
+All notable changes to the "tinymist" extension will be documented in this file.
+
+Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
+
+## v0.10.0 - [2024-3-11]
+
+Initial release corresponding to Typst v0.11.0-rc1.

editors/vscode/README.md

@@ -11,20 +11,28 @@ See [Tinymist features](../../README.md#features) for a list of features.
 - This extension compiles to PDF, but it doesn't have a PDF viewer yet. To view
   the output as you work, install a PDF viewer extension, such as
   `vscode-pdf`.
+- There is a **global** configuration `tinymist.typstExtraArgs` to pass extra arguments to tinymist LSP, like what you usually do with `typst-cli` CLI.
+  - For example, you can set it to `["--input=awa=1", "--input=abaaba=2"]` to configure `sys.inputs`.
+  - Note: the arguments has quite low priority, and that may be overridden by other settings.
+- To find a way to compile PDF:
+  - Use command `Typst Show PDF ...` to show the current document to PDF.
+  - Use command `Typst Export PDF ...` to export the current document to PDF.
+  - There are code lens buttons at the start of the document to export your
+    document to PDF or other formats.
 - To configure when PDFs are compiled:
   1. Open settings.
     - File -> Preferences -> Settings (Linux, Windows)
     - Code -> Preferences -> Settings (Mac)
   2. Search for "Tinymist Export PDF".
-  3. Change the Export PDF setting.
+  3. Change the "Export PDF" setting.
     - `onSave` makes a PDF after saving the Typst file.
     - `onType` makes PDF files live, as you type.
     - `never` disables PDF compilation.
     - "onDocumentHasTitle" makes a PDF when the document has a title and, as you save.
 - To configure where PDFs are saved:
   1. Open settings.
   2. Search for "Tinymist Output Path".
-  3. Change the Export PDF setting. This is the path pattern to store artifacts, you can use `$root` or `$dir` or `$name` to do magic configuration
+  3. Change the "Output Path" setting. This is the path pattern to store artifacts, you can use `$root` or `$dir` or `$name` to do magic configuration
     - e.g. `$root/$dir/$name` (default) for `$root/path/to/main.pdf`.
     - e.g. `$root/target/$dir/$name` for `$root/target/path/to/main.pdf`.
     - e.g. `$root/target/foo` for `$root/target/foo.pdf`. This will ensure that the output is always output to `target/foo.pdf`.