---
title: Guide
description: >
  This guide provides instructions and examples for using Panache, including
  how to set up the language server in your editor, run the linte or formatter
  from the command line, and configuring the behavior of Panache.
---

- In [Formatting](formatting.qmd) you can find instructions on how to use
  Panache to format your documents, showing examples of the formatting rules and
  how to customize them.

- In [Linting](linting.qmd) you can find instructions on how to use Panache to
  lint your documents, showing examples of the linting rules and how to
  customize them.

- In [Language Server](lsp.qmd) we describe the Panache Language Server, which
  beyond formatting and linting also provides features like code completion,
  hover information, document/workspace symbols, renaming, and code actions.

- In [configuration](configuration.qmd) we describe how to configure Panache,
  both globally and on a per-project basis, and how to use configuration files
  to customize the formatting and linting rules.

- In [Integrations](integrations.qmd) we describe how to integrate Panache with
  other tools, such as pre-commit hooks and GitHub actions, to automatically
  format and lint your documents on commit or pull request.

- In [Comparison with Other Tools](comparison.qmd) we compare Panache to other
  formatters, linters, and language servers in the Markdown/Pandoc/Quarto space,
  to help you choose the right tool (or combination) for your project.

- In [Performance](performance.qmd) we present benchmarks comparing Panache's
  formatting and linting speed against popular alternatives on real Markdown and
  Quarto documents.
