Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Descriptions to Doc Files #8

Merged
merged 3 commits into from
Jun 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/content/docs/core-concepts/embedded-languages.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Embedded languages
description: VolarJS has top-notch support for embedded languages and can drastically simplify the mappings needed to get editing features working across the different parts of your files.
---

A lot of programming languages used these days are composed of other programming languages. The most famous example is HTML, in which you will find JavaScript and CSS in `<script>` and `<style>` blocks respectively. In addition to those, 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.
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/core-concepts/volar-labs.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Volar Labs
description: A VS Code extension to help you debug your Volar-powered language server and client.
---

Having a common framework for building editor tooling has many benefits. It allows us to share code, it allows us to share knowledge, and most importantly, it allows us to share the pain of building editor tooling.
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/core-concepts/why-volar.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Why Volar?
description: Advantages of using Volar and why you would want to use it.
---

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.
Expand Down
3 changes: 2 additions & 1 deletion src/content/docs/guides/file-structure.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "File Structure of typical Volar project"
title: "File Structure of a typical Volar project"
description: A guide to understand the file structure of a typical Volar project.
---

This guide will show you how a Volar project is organized and what the different files in your project do.
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/guides/first-server.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Your First Volar Language Server
description: A simple guide to creating your first Volar language server.
---

> This page is a work in progress. Interested in contributing some documentation to it, or want to improve it? [Edit this page on GitHub](https://github.com/volarjs/docs/blob/main/src/content/docs/guides/first-server.mdx)
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Volar
description: The Embedded Language Tooling Framework.
description: VolarJS is a modern embedded language tooling framework that aims to simplify the development of language support for editors.
template: splash
hero:
tagline: The Embedded Language Tooling Framework.
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/reference/services.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Services
description: A list of available services in VolarJS and how to use them.
---

Services are the building blocks of Volar language servers. They are responsible for providing all the features you'd expect in a language server, completions, diagnostics, hover information, you name it.
Expand Down