-
-
Notifications
You must be signed in to change notification settings - Fork 25
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
Create racket-langserver.scrbl #130
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
#lang scribble/manual | ||
@(require scribble/extract | ||
(for-label racket)) | ||
|
||
@title{racket-langserver} | ||
|
||
The @tt{racket-langserver} is a @hyperlink["https://langserver.org/"]{Language Server Protocol} | ||
implementation for Racket. This project seeks to use | ||
@seclink[#:indirect? #t #:doc '(lib "scribblings/drracket-tools/drracket-tools.scrbl") "top"]{DrRacket's public APIs} | ||
to provide functionality that mimics DrRacket's code tools as closely as possible. | ||
|
||
@section{Installation and usage} | ||
|
||
A Racket runtime is a prerequisite, so before using @tt{racket-langserver}, ensure that a Racket runtime | ||
is installed. You can install an from the @hyperlink["https://download.racket-lang.org"]{official download page} | ||
or install one from your package manager. | ||
|
||
@section{VSCode} | ||
|
||
Use the @hyperlink["https://marketplace.visualstudio.com/items?itemName=evzen-wybitul.magic-racket"]{Magic Racket} extension. | ||
|
||
@section{Other editors and IDEs} | ||
|
||
First, install an LSP runtime for your editor. | ||
|
||
Next, install the package via @tt{raco}: | ||
|
||
@commandline{raco pkg install racket-langserver} | ||
|
||
Once it is installed, you can configure your editor to use a custom LSP client for Racket files (@tt{.rkt}), | ||
and set the command for the custom client to | ||
|
||
@commandline{racket -l racket-langserver} | ||
|
||
You may need to restart your LSP runtime or your editor for `racket-langserver` to start. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The Markdown syntax should be changed to Scribble. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. done There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. done |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IIRC, VSCode requires users to run
raco pkg install racket-langserver
too, right? It feels weird to have the instructions in "Other editors and IDEs" but not here.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
reorganised to address this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
covered in the guidance at https://marketplace.visualstudio.com/items?itemName=evzen-wybitul.magic-racket