mirror of
https://github.com/rust-lang/rust-analyzer
synced 2024-12-26 21:13:37 +00:00
editors/code: Add md for walkthrough setup example
Add a separate markdown file containing the settings.json snippet from the "Useful Setup Tips". This fixes the rendering and also makes the text selectable. Also use double-backticks for `code` rendering.
This commit is contained in:
parent
6a67a4d3cd
commit
d2e856ccc4
3 changed files with 14 additions and 4 deletions
|
@ -12,3 +12,4 @@
|
||||||
!ra_syntax_tree.tmGrammar.json
|
!ra_syntax_tree.tmGrammar.json
|
||||||
!server
|
!server
|
||||||
!README.md
|
!README.md
|
||||||
|
!walkthrough-setup-tips.md
|
||||||
|
|
|
@ -3224,10 +3224,9 @@
|
||||||
{
|
{
|
||||||
"id": "setup",
|
"id": "setup",
|
||||||
"title": "Useful Setup Tips",
|
"title": "Useful Setup Tips",
|
||||||
"description": "There are a couple of things you might want to configure upfront to your tastes. We'll name a few here but be sure to check out the docs linked below!\n\n**Marking library sources as readonly**\n\nAdding the following to your settings.json will mark all Rust library sources as readonly:\n```json\n\"files.readonlyInclude\": {\n \"**/.cargo/registry/src/**/*.rs\": true,\n \"**/lib/rustlib/src/rust/library/**/*.rs\": true,\n},\n```\n\n**Check on Save**\n\nBy default, rust-analyzer will run `cargo check` on your codebase when you save a file, rendering diagnostics emitted by `cargo check` within your code. This can potentially collide with other `cargo` commands running concurrently, blocking them from running for a certain amount of time. In these cases it is recommended to disable the `rust-analyzer.checkOnSave` configuration and running the `rust-analyzer: Run flycheck` command on-demand instead.",
|
"description": "There are a couple of things you might want to configure upfront to your tastes. We'll name a few here but be sure to check out the docs linked below!\n\n**Marking library sources as readonly**\n\nAdding the snippet on the right to your settings.json will mark all Rust library sources as readonly.\n\n**Check on Save**\n\nBy default, rust-analyzer will run ``cargo check`` on your codebase when you save a file, rendering diagnostics emitted by ``cargo check`` within your code. This can potentially collide with other ``cargo`` commands running concurrently, blocking them from running for a certain amount of time. In these cases it is recommended to disable the ``rust-analyzer.checkOnSave`` configuration and running the ``rust-analyzer: Run flycheck`` command on-demand instead.",
|
||||||
"media": {
|
"media": {
|
||||||
"image": "./icon.png",
|
"markdown": "./walkthrough-setup-tips.md"
|
||||||
"altText": "rust-analyzer logo"
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
@ -3245,7 +3244,7 @@
|
||||||
{
|
{
|
||||||
"id": "faq",
|
"id": "faq",
|
||||||
"title": "FAQ",
|
"title": "FAQ",
|
||||||
"description": "What are these code hints that are being inserted into my code?\n\nThese hints are called inlay hints which rust-analyzer support and are enabled by default in VSCode. If you wish to disable them you can do so via the `editor.inlayHints.enabled` setting.",
|
"description": "What are these code hints that are being inserted into my code?\n\nThese hints are called inlay hints which rust-analyzer support and are enabled by default in VSCode. If you wish to disable them you can do so via the ``editor.inlayHints.enabled`` setting.",
|
||||||
"media": {
|
"media": {
|
||||||
"image": "icon.png",
|
"image": "icon.png",
|
||||||
"altText": "rust-analyzer logo"
|
"altText": "rust-analyzer logo"
|
||||||
|
|
10
editors/code/walkthrough-setup-tips.md
Normal file
10
editors/code/walkthrough-setup-tips.md
Normal file
|
@ -0,0 +1,10 @@
|
||||||
|
# Settings Example
|
||||||
|
|
||||||
|
Add the following to settings.json to mark Rust library sources as read-only:
|
||||||
|
|
||||||
|
```json
|
||||||
|
"files.readonlyInclude": {
|
||||||
|
"**/.cargo/registry/src/**/*.rs": true,
|
||||||
|
"**/lib/rustlib/src/rust/library/**/*.rs": true,
|
||||||
|
},
|
||||||
|
```
|
Loading…
Reference in a new issue