Skip to content

Commit

Permalink
Merge pull request #1 from morinokami/patch-0
Browse files Browse the repository at this point in the history
Fix typos, etc. in Core Concepts
  • Loading branch information
Princesseuh authored Sep 6, 2023
2 parents 5c428cf + 3509aa0 commit dea8a45
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions src/content/docs/core-concepts/embedded-languages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ title: Embedded languages
description: A guide in my new Starlight docs site.
---

In the web, most programming languages are composed of other programming languages. The most common example being HTML, in which you will find JavaScript and CSS in `<script>` and `<style>` blocks respectively. You can even find some inline CSS in the `style` attribute of HTML elements, and some inline JavaScript in the `onclick` (and other events) attribute of HTML elements.
On the web, most programming languages are composed of other programming languages. The most common example is HTML, in which you will find JavaScript and CSS in `<script>` and `<style>` blocks respectively. You can even find some inline CSS in the `style` attribute of HTML elements, and some inline JavaScript in the `onclick` (and other events) attribute of HTML elements.

There is actually a remarkable amount of examples of this behaviour: The different blocks in [Vue's Single-File Components](https://vuejs.org/guide/scaling-up/sfc.html), the sections in [Svelte's components](https://svelte.dev/docs/svelte-components) or the frontmatter syntax and JSX-based component template of [Astro's components](https://docs.astro.build/en/core-concepts/astro-components/).
There is actually a remarkable number of examples of this behaviour: The different blocks in [Vue's Single-File Components](https://vuejs.org/guide/scaling-up/sfc.html), the sections in [Svelte's components](https://svelte.dev/docs/svelte-components) or the frontmatter syntax and JSX-based component template of [Astro's components](https://docs.astro.build/en/core-concepts/astro-components/).

As such, Volar was built on the principle that it is highly likely that your language will have such embedded languages and has top-notch support for them. Notably, Volar can drastically simplify the mappings needed to get editing features working across the different parts of your files.

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/core-concepts/volar-labs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Volar Labs is a VS Code extension to help you debug your Volar-powered language

## Installation

Volar Labs is available on the VS Code Marketplace. You can install it by searching for `volar-labs` in the Extensions tab of VS Code, or by [clicking here](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar-labs).
Volar Labs is available on the VS Code Marketplace. You can install it by searching for `volarjs-labs` in the Extensions tab of VS Code, or by [clicking here](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volarjs-labs).

## Features

Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/core-concepts/why-volar.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: Why Volar?
description: A guide in my new Starlight docs site.
---

Over the years, programmers have started relying more and more on their codeeditors to provide them with helpful contextual information and hints about their code. Features such as hover information, diagnostics, and auto-completions are now an absolute norm that users rightfully expect from their editors, no matter what programming languages they are working with.
Over the years, programmers have started relying more and more on their code editors to provide them with helpful contextual information and hints about their code. Features such as hover information, diagnostics, and auto-completions are now an absolute norm that users rightfully expect from their editors, no matter what programming languages they are working with.

However, implementing such features is not only, not a trivial task, it's also understandably rarely the priority of the languages and frameworks authors. And even if you do have the time and resources to implement such features, it's hard to do right, requires a fair amount of domain knowledge, and can be very time consuming to maintain.
However, implementing such features is not only a non-trivial task, but it's also understandably rarely the priority of the languages and frameworks authors. And even if you do have the time and resources to implement such features, it's hard to do right, requires a fair amount of domain knowledge, and can be very time consuming to maintain.

**Volar aims to solve this problem by taking care of all the heavy lifting.** Volar provides you all the tools you need to build a great editing experience for your users without having to worry about the nitty-gritty details so you can focus on what matters most to you: Making your language or framework awesome.

0 comments on commit dea8a45

Please sign in to comment.