Skip to content

Commit ad95f08

Browse files
authored
Update README.md
1 parent f4cfaa3 commit ad95f08

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Markdoc language server
2+
13
This is the official Visual Studio Code extension and language server for the [Markdoc](https://markdoc.dev/) authoring framework.
24

35
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
1517
- Creating new Markdoc files from user-defined templates via the new file menu
1618
- Linked editing for matched opening and closing tag names
1719

18-
# Configuration quickstart
20+
## Configuration quickstart
1921

2022
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.
2123

@@ -55,15 +57,15 @@ It is possible to have multiple Markdoc configurations for the same workspace by
5557

5658
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.
5759

58-
# Extending the language server with custom functionality
60+
## Extending the language server with custom functionality
5961

6062
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.
6163

62-
# Contributing
64+
## Contributing
6365

6466
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).
6567

66-
## Building from source
68+
### Building from source
6769

6870
```
6971
$ npm install
@@ -73,14 +75,14 @@ $ npm run build:types
7375
$ npm run build:extension
7476
```
7577

76-
## Running unit tests
78+
### Running unit tests
7779

7880
The test suite relies on the 'node:test' module that is only included in Node.js 18.x or higher.
7981

8082
```
8183
$ npm run test
8284
```
8385

84-
# License
86+
## License
8587

8688
This project uses the [MIT license](LICENSE).

0 commit comments

Comments
 (0)