### VSCode Extension Setup

Source: https://github.com/artempyanykh/marksman/blob/main/README.md

Information on installing and using the Marksman VSCode extension for enhanced Markdown editing within Visual Studio Code.

```APIDOC
VSCode Extension:
  Name: Marksman VSCode Extension
  Source: https://github.com/artempyanykh/marksman-vscode
  Installation:
    1. Open VSCode.
    2. Go to the Extensions view (Ctrl+Shift+X or Cmd+Shift+X).
    3. Search for "Marksman".
    4. Click 'Install'.
  Features:
    - Provides language server features for Markdown files.
    - Supports cross-file references and completions.
    - Integrates with VSCode's built-in Markdown preview.
  Configuration:
    - Most features work out-of-the-box.
    - Ensure your project has a root (e.g., via `.marksman.toml` or `.git`) for workspace features.
  Notes:
    - For VSCode-specific advanced features, consider the "Markdown Memo" extension.
    - Marksman itself is a generic language server, usable with any LSP-compatible editor.
```

--------------------------------

### Install Marksman via Snap (Edge)

Source: https://github.com/artempyanykh/marksman/blob/main/docs/install.md

Installs the edge release of Marksman, which is built from the main branch. This provides access to the latest development features and fixes.

```bash
sudo snap install --edge marksman
```

--------------------------------

### Build Marksman from Source

Source: https://github.com/artempyanykh/marksman/blob/main/docs/install.md

Instructions to build the Marksman tool from its source code. This requires cloning the repository and using the provided build script.

```shell
git clone https://github.com/artempyanykh/marksman.git
```

```shell
cd marksman
make install
```

--------------------------------

### Prepare Pre-built Binary for Windows

Source: https://github.com/artempyanykh/marksman/blob/main/docs/install.md

Steps to prepare a downloaded pre-built binary for Marksman on Windows. This involves renaming the executable file.

```powershell
Rename-Item -Path marksman-windows.exe -NewName marksman.exe
```

--------------------------------

### Sublime Text LSP Setup

Source: https://github.com/artempyanykh/marksman/blob/main/README.md

Instructions for integrating Marksman with Sublime Text using the LSP-marksman package.

```APIDOC
Sublime Text LSP Integration:
  Package: LSP-marksman
  Source: https://github.com/sublimelsp/LSP-marksman
  Installation:
    1. Install Package Control if you haven't already.
    2. Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P).
    3. Type 'Package Control: Install Package' and press Enter.
    4. Search for 'LSP-marksman' and select it to install.
  Configuration:
    - Ensure Marksman is installed and in your system's PATH.
    - LSP-marksman will automatically detect and configure Marksman.
    - For custom configurations or binary paths, refer to the LSP-marksman package documentation.
  Features:
    - Enables language server features for Markdown files within Sublime Text.
    - Supports cross-file linking and symbol navigation.
```

--------------------------------

### Prepare Pre-built Binary for macOS/Linux

Source: https://github.com/artempyanykh/marksman/blob/main/docs/install.md

Steps to prepare a downloaded pre-built binary for Marksman on macOS and Linux. This involves renaming the executable and making it executable.

```shell
mv marksman-macos marksman && chmod +x marksman
```

```shell
mv marksman-linux marksman && chmod +x marksman
```

--------------------------------

### Install Marksman via Nix

Source: https://github.com/artempyanykh/marksman/blob/main/docs/install.md

Installs the Marksman tool using the Nix package manager. This command adds Marksman to your user profile, making it available system-wide.

```shell
nix-env -iA nixpkgs.marksman
```

--------------------------------

### Neovim LSP Configuration with Eglot

Source: https://github.com/artempyanykh/marksman/blob/main/README.md

Guide for integrating Marksman with Neovim using the Eglot LSP client. This involves specifying the command to run the Marksman server.

```lua
-- Ensure Marksman is installed and in your PATH

local lspconfig = require('lspconfig')

lspconfig.marksman.setup({
  -- Eglot specific setup if needed, but typically lspconfig handles it
  -- If marksman is not in PATH, you might need to specify cmd:
  -- cmd = { "/path/to/your/marksman", "--stdio" },
})

-- If using Eglot directly without lspconfig:
-- require('eglot').attach_client({
--   name = 'marksman',
--   cmd = {'marksman', '--stdio'},
--   root_dir = lspconfig.util.root_pattern('.git', '.marksman.toml'),
-- })

```

--------------------------------

### Install Marksman via Snap (Stable)

Source: https://github.com/artempyanykh/marksman/blob/main/docs/install.md

Installs the latest stable release of Marksman using Snap. This is a convenient method for Linux distributions that support Snap packages.

```bash
sudo snap install marksman
```

--------------------------------

### Coc.nvim Integration

Source: https://github.com/artempyanykh/marksman/blob/main/README.md

Guide for setting up Marksman with Coc.nvim, a powerful LSP client for Vim and Neovim.

```APIDOC
Coc.nvim Integration:
  Extension: coc-marksman
  Source: https://github.com/yaegassy/coc-marksman
  Installation:
    1. Ensure Coc.nvim is installed and configured in your Vim/Neovim.
    2. Install the coc-marksman extension using Coc's command:
       :CocInstall coc-marksman
  Configuration:
    - Marksman executable should be in your system's PATH.
    - If not, you can specify the path in your coc-settings.json:
      {
        "languageserver": {
          "marksman": {
            "command": "/path/to/your/marksman",
            "args": ["--stdio"]
          }
        }
      }
  Features:
    - Provides completion, diagnostics, go-to-definition, and more for Markdown.
    - Leverages Marksman's language server capabilities.
```

--------------------------------

### Install Marksman via Homebrew

Source: https://github.com/artempyanykh/marksman/blob/main/docs/install.md

Installs the Marksman tool using the Homebrew package manager. This method is suitable for macOS and Linux users who have Homebrew installed.

```bash
brew install marksman
```

--------------------------------

### Emacs LSP Mode Configuration

Source: https://github.com/artempyanykh/marksman/blob/main/README.md

Configuration for integrating Marksman with LSP Mode in Emacs, typically used with markdown-mode. This setup enables automatic server installation and LSP features for Markdown editing.

```lisp
(use-package markdown-mode
  :hook (markdown-mode . lsp)
  :config
  (require 'lsp-marksman))
```

--------------------------------

### Wiki-Links Example

Source: https://github.com/artempyanykh/marksman/blob/main/README.md

Shows how to create wiki-style links for note-taking, enabling Zettelkasten-like workflows. Marksman supports linking to other notes, specific headings within notes, and internal document anchors, providing diagnostics for broken references.

```Markdown
Link to [[another-note]].
Link to [[another-notes#heading]].
Internal link to [[#a-heading]].
```

--------------------------------

### Markdown Inline Links Example

Source: https://github.com/artempyanykh/marksman/blob/main/README.md

Demonstrates how to use inline links within Markdown files, including links to specific files and internal anchors. Marksman provides completion, hover, and goto definition for these links.

```Markdown
This is [inline link](/some-file.md#some-heading).
This is an internal [anchor link](#heading).
```

--------------------------------

### Markdown Reference Links Example

Source: https://github.com/artempyanykh/marksman/blob/main/README.md

Illustrates the use of reference-style links in Markdown, where the link destination and optional title are defined separately. Marksman supports these for navigation and completion.

```Markdown
See [reference].

[reference]: /url "Title"
```

--------------------------------

### Bypass macOS Quarantine for Marksman

Source: https://github.com/artempyanykh/marksman/blob/main/docs/install.md

Command to bypass the macOS security warning for downloaded binaries. This command removes the quarantine attribute from the Marksman executable.

```shell
xattr -d com.apple.quarantine <path-to-marksman-bin>
```

--------------------------------

### Vim LSP Configuration

Source: https://github.com/artempyanykh/marksman/blob/main/README.md

Configuration snippet for integrating Marksman with the native LSP client in Vim. This requires specifying the path to the Marksman executable and its arguments for server initialization.

```viml
if exists('g:loaded_lsp')
  call LspAddServer([#{ name: 'marksman', filetype: ['markdown'], path: '/path/to/marksman', args: ['server'], syncInit: v:true }])
end
```

--------------------------------

### Neovim LSP Configuration with Mason and nvim-lspconfig

Source: https://github.com/artempyanykh/marksman/blob/main/README.md

Instructions for setting up Marksman as a language server in Neovim using the popular mason.nvim and nvim-lspconfig plugins. This ensures proper integration for features like completion and diagnostics.

```lua
-- Ensure mason.nvim is installed and configured
-- :MasonInstall marksman

local lspconfig = require('lspconfig')

lspconfig.marksman.setup({
  -- Optional: Add any specific configuration for marksman here
  -- For example, to specify the path to the binary if not in PATH:
  -- cmd = { "/path/to/your/marksman", "--stdio" },
  -- on_attach = function(client, bufnr)
  --   -- Your on_attach logic here
  -- end,
})

```

--------------------------------

### Configure Project Root for Workspace Mode

Source: https://github.com/artempyanykh/marksman/blob/main/README.md

To enable cross-file references and completions, Marksman requires a project root. Creating an empty `.marksman.toml` file in your project's root directory initializes this workspace mode.

```toml
# Create an empty .marksman.toml file in your project root
# Example: touch .marksman.toml
```

--------------------------------

### API Documentation: Marksman Configuration Options

Source: https://github.com/artempyanykh/marksman/blob/main/docs/features.md

This section outlines key configuration options for Marksman, detailing how to customize its behavior for title handling and link completion styles. These settings are crucial for tailoring the language server to specific project needs and workflows.

```APIDOC
Marksman Configuration:

- core.title_from_heading: boolean
  - Description: Controls whether the Level 1 heading (`# Foo`) is treated as the document's title. Defaults to true.
  - Default: true
  - Example:
    ```toml
    [core]
    title_from_heading = false
    ```

- completion.wiki.style: string
  - Description: Configures the preferred style for completing wiki links (`[[...]]`). Options include title-based or file-based referencing. This impacts how links resolve and how refactorings behave.
  - Possible Values: "title-slug", "file-stem"
  - Default: "title-slug" (when title_from_heading is true), "file-stem" (when title_from_heading is false)
  - Related: Affects refactoring behavior when renaming titles or files.

- Ignore Files:
  - Description: Marksman reads ignore globs from `.gitignore`, `.hgignore`, and `.ignore` files. It scans sub-folders for these files, similar to Git's behavior, to exclude directories from indexing and processing.
  - Supported Files: `.gitignore`, `.hgignore`, `.ignore`

- Project Root Detection:
  - Description: Marksman identifies project roots based on VCS repository roots or the presence of a `.marksman.toml` marker file. This is essential for enabling cross-file language features.
  - Methods:
    1. Root of a VCS repository (e.g., Git, Mercurial).
    2. Folder containing a `.marksman.toml` file.
  - Note: For single-file mode, features are a subset. Project setup is recommended for interconnected documents.
```

--------------------------------

### Helix Editor Integration

Source: https://github.com/artempyanykh/marksman/blob/main/README.md

Details on configuring Marksman for use with the Helix editor, leveraging its LSP client capabilities.

```APIDOC
Helix Editor Integration:
  Language Server: Marksman
  Configuration File: helix/languages.toml
  Setup:
    1. Ensure Marksman is installed and accessible in your system's PATH.
    2. Configure Helix to use Marksman as the language server for Markdown files.
  Example helix/languages.toml entry:
    [[language]]
    name = "markdown"
    scope = "text.html.markdown"
    file-types = ["md"]
    roots = ["git", ".marksman.toml"]
    language-servers = [
      {
        name = "marksman",
        # If marksman is not in PATH, specify the executable path:
        # command = "/path/to/your/marksman"
      }
    ]
  Features:
    - Provides code completion, diagnostics, and navigation for Markdown.
    - Supports workspace features when a project root is detected.
```

--------------------------------

### Vim ALE Configuration

Source: https://github.com/artempyanykh/marksman/blob/main/README.md

Configuration snippet for integrating Marksman with the ALE (Asynchronous Lint Engine) plugin in Vim. This allows Marksman to provide linting and other LSP features for Markdown files within Vim.

```viml
if exists('g:loaded_ale')
  call ale#linter#Define('markdown', { 'name': 'marksman', 'lsp': 'stdio', 'executable': 'marksman', 'command': '%e server', 'initialization_options': {} })
end
```

--------------------------------

### Zed Editor Configuration

Source: https://github.com/artempyanykh/marksman/blob/main/README.md

Configuration for the Zed editor to recognize and use Marksman as a language server for Markdown files. This involves specifying 'marksman' in the language server list for Markdown.

```jsonc
// Zed settings
{
  // ...
  "languages": {
    "Markdown": {
      "language_servers": ["marksman"]
    }
  }
}

```

--------------------------------

### Bypass MacOS Quarantine for Marksman

Source: https://github.com/artempyanykh/marksman/blob/main/README.md

On macOS, you might encounter a security warning when trying to open the Marksman binary. This command bypasses the quarantine attribute, allowing the application to run.

```shell
xattr -d com.apple.quarantine <path-to-marksman-bin>
```

--------------------------------

### Emacs Eglot Configuration

Source: https://github.com/artempyanykh/marksman/blob/main/README.md

Configuration for integrating Marksman with the Eglot LSP client in Emacs. This snippet adds Marksman as a language server program for markdown-mode, enabling LSP functionalities.

```lisp
(add-to-list 'eglot-server-programs '(markdown-mode . ("marksman")))
(add-hook 'markdown-mode-hook #'eglot-ensure)
```

--------------------------------

### TOML Configuration: Title from Heading

Source: https://github.com/artempyanykh/marksman/blob/main/docs/features.md

This TOML snippet demonstrates how to disable the default behavior of treating the Level 1 heading as the document's title. This setting affects how Marksman interprets document structure and can change default completion styles.

```toml
[core]
title_from_heading = false
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.