You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-6Lines changed: 8 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -1,3 +1,5 @@
1
+
# Markdoc language server
2
+
1
3
This is the official Visual Studio Code extension and language server for the [Markdoc](https://markdoc.dev/) authoring framework.
2
4
3
5
When the language server and extension are used together and configured to load a Markdoc schema, they support the following features:
@@ -15,7 +17,7 @@ When the language server and extension are used together and configured to load
15
17
- Creating new Markdoc files from user-defined templates via the new file menu
16
18
- Linked editing for matched opening and closing tag names
17
19
18
-
# Configuration quickstart
20
+
##Configuration quickstart
19
21
20
22
After installing the Markdoc extension in Visual Studio Code, create a Markdoc language server configuration file. The extension looks for a file called `markdoc.config.json` in your workspace root, but you can customize this in the extension's settings.
21
23
@@ -55,15 +57,15 @@ It is possible to have multiple Markdoc configurations for the same workspace by
55
57
56
58
In [multi-root workspaces](https://code.visualstudio.com/docs/editor/multi-root-workspaces), a Markdoc configuration file is specific to an individual workspace root. You can have separate Markdoc configuration files for each root. If you need to override the location of the Markdoc language server configuration file in a multi-root workspace, you can use a [folder setting](https://code.visualstudio.com/docs/editor/multi-root-workspaces#_settings) to customize this behavior per root.
57
59
58
-
# Extending the language server with custom functionality
60
+
##Extending the language server with custom functionality
59
61
60
62
The language server is published as a [package on npm](https://www.npmjs.com/package/@markdoc/language-server) in order to support extensibility and customization. You can tailor the functionality to your needs by adding plugins or creating subclasses that substitute built-in plugins. Support for this is somewhat experimental and the APIs exposed by the package are still subject to change. We will not guarantee API stability or backwards compatibility for language server plugins until the 1.0 release.
61
63
62
-
# Contributing
64
+
##Contributing
63
65
64
66
Contributions and feedback are welcomed and encouraged. Feel free to open PRs here, or open issues and discussion threads in the [Markdoc core repo](https://github.com/markdoc/markdoc).
65
67
66
-
## Building from source
68
+
###Building from source
67
69
68
70
```
69
71
$ npm install
@@ -73,14 +75,14 @@ $ npm run build:types
73
75
$ npm run build:extension
74
76
```
75
77
76
-
## Running unit tests
78
+
###Running unit tests
77
79
78
80
The test suite relies on the 'node:test' module that is only included in Node.js 18.x or higher.
0 commit comments