Comments (6)
JPinkney
commented on May 27, 2024
This behaves in the same way as vscode json where the language server escapes the markdown. According to json spec for description it doesn't say it should be markdown (nor does it say it shouldn't) so its escaped. In the case of vscode json it looks like they added a custom field called markdownDescription. Heres the vscode json discussion
from yaml-language-server.
gorkem
commented on May 27, 2024
@JPinkney Do we support markdownDescription on our schemas?
from yaml-language-server.
JPinkney
commented on May 27, 2024
Yes we do. We have markdownDescription and markdownEnumDescriptions available to render markdown.
from yaml-language-server.
felixfbecker
commented on May 27, 2024
So I just have to add markdownDescription to the schema in addition to description?
from yaml-language-server.
JPinkney
commented on May 27, 2024
markdownDescription is an alternative to description. This was the gist I was playing around with
from yaml-language-server.
felixfbecker
commented on May 27, 2024
Are they exclusive? I would be worried about only providing markdownDescription because probably not all clients support it
from yaml-language-server.
Related Issues (20)
- Completion suggestions for arrays, integers suggest ${} placeholders
- Numbers in comments HOT 1
- Don't send workspace/configuration to clients that don't support it HOT 1
- Prettifying Example Payload Stopped Working
- `- array item` suggestion gives extra line HOT 1
- `rangeFormatting` is used to register whole-document `formatting` capability
- Remove formatting provider HOT 4
- Yaml cant seem to process draft-4/7 schema editing HOT 1
- yaml is not validating correctly the config.yml file for github
- openapi discriminators
- Proposal for Donating the yaml-language-server Project to an Open Governance Foundation HOT 4
- Show enum values on hover HOT 1
- Github workflow deploy.yml detected as a PHP Deployer config
- docs: The examples in the README have their syntax set wrong
- YAML `---` for "Multiple documents within a single stream" doesn't work [YAML Language Server] HOT 1
- Cannot Load content for: schema.json Unknown schema: file
- URL fragment references does not resolve correctly
- Use inline JSON Schema w/o modeline - make `yaml-language-server` string optional
- Hover: Show root property title and description when using anyOf untitled un-described types
- Schema association with fallbacks (wildcards) HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from yaml-language-server.