Skip to content

Add a note about relative links in MarkupContent #1443

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.

Sign up for GitHub

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

Open
wants to merge 3 commits into
base: gh-pages
Choose a base branch
from
Open

Add a note about relative links in MarkupContent #1443

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c2088ac
Add a note about relative links in MarkupContent
DanTup Apr 12, 2022
96c8344
Remove words
DanTup Apr 12, 2022
b9e0b2d
Merge branch 'gh-pages' into base-uri
dbaeumer Dec 12, 2023
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
2 changes: 1 addition & 1 deletion _specifications/lsp/3.17/types/markupContent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#### <a href="#markupContent" name="markupContent" class="anchor"> MarkupContent </a>

A `MarkupContent` literal represents a string value which content can be represented in different formats. Currently `plaintext` and `markdown` are supported formats. A `MarkupContent` is usually used in documentation properties of result literals like `CompletionItem` or `SignatureInformation`. If the format is `markdown` the content should follow the [GitHub Flavored Markdown Specification](https://github.github.com/gfm/).
A `MarkupContent` literal represents a string value which content can be represented in different formats. Currently `plaintext` and `markdown` are supported formats. A `MarkupContent` is usually used in documentation properties of result literals like `CompletionItem` or `SignatureInformation`. If the format is `markdown` the content should follow the [GitHub Flavored Markdown Specification](https://github.github.com/gfm/). `MarkupContent` in returned in responses to requests that are scoped to a document may contain relative links, which will be resolved relative to that document.

```typescript
/**
Expand Down