https://github.com/euclio/mdpls

Markdown Preview Language Server
https://github.com/euclio/mdpls

editor-plugin language-server markdown markdown-previewer

Last synced: 14 days ago
JSON representation

Markdown Preview Language Server

• Host: GitHub
• URL: https://github.com/euclio/mdpls
• Owner: euclio
• Created: 2020-01-30T21:51:24.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-05-27T07:28:58.000Z (6 months ago)
• Last Synced: 2024-10-12T18:48:02.079Z (29 days ago)
• Topics: editor-plugin, language-server, markdown, markdown-previewer
• Language: Rust
• Size: 28.3 KB
• Stars: 49
• Watchers: 4
• Forks: 8
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# mdpls: Markdown Preview Language Server

> Markdown, please!

mdpls is a [language server] that provides a live HTML preview of your markdown

in your browser.

mdpls is powered by [aurelius], which also powers [vim-markdown-composer].

### Installation

mdpls requires stable Rust, which can easily be installed and updated via

[rustup].

```sh

cargo install --git https://github.com/euclio/mdpls

```

The `mdpls` binary will be installed to `.cargo/bin` in your home directory.

### Usage

mdpls works with your [favorite editor's LSP plugin][lsp-tools]. Consult

your plugin's documentation for information on how to configure a new language

server.

Like most language servers, mdpls operates over stdin and stdout.

### Configuration

| Setting | Type | Description | Default

| - | - | - | -

| `markdown.preview.auto` | boolean | Open the markdown preview automatically. | `true`

| `markdown.preview.browser` | array or string | The program and arguments to use for opening the preview window. If not specified, the user's default browser will be used. The preview URL will be appended to this program as an argument. | None

| `markdown.preview.codeTheme` | string | [highlight.js style] to use for syntax highlighting in code blocks. | `github`

| `markdown.preview.serveStatic` | boolean | Serve static files like images (this should only be use with trusted documents) | `false`

| `markdown.preview.renderer` | array or string | The program to use to render the markdown to html. If not specified, the builtin markdown renderer will be used. | None

### Commands

The language server also provides commands for interacting with the browser preview.

| Command | Description

| - | -

| `Open Preview` | Opens the markdown preview.

[language server]: https://microsoft.github.io/language-server-protocol/

[aurelius]: https://github.com/euclio/aurelius

[vim-markdown-composer]: https://github.com/euclio/vim-markdown-composer

[rustup]: https://rustup.rs

[lsp-tools]: https://microsoft.github.io/language-server-protocol/implementors/tools/

[highlight.js style]: https://highlightjs.org/static/demo/