docs/integrations/index.md

   1 # Integrations
   2
   3 ```{toctree}
   4 ---
   5 hidden:
   6 ---
   7
   8 editors
   9 github_actions
  10 source_version_control
  11 ```
  12
  13 _Black_ can be integrated into many environments, providing a better and smoother
  14 experience. Documentation for integrating _Black_ with a tool can be found for the
  15 following areas:
  16
  17 - {doc}`Editor / IDE <./editors>`
  18 - {doc}`GitHub Actions <./github_actions>`
  19 - {doc}`Source version control <./source_version_control>`
  20
  21 Editors and tools not listed will require external contributions.
  22
  23 Patches welcome! ✨ 🍰 ✨
  24
  25 Any tool can pipe code through _Black_ using its stdio mode (just
  26 [use `-` as the file name](https://www.tldp.org/LDP/abs/html/special-chars.html#DASHREF2)).
  27 The formatted code will be returned on stdout (unless `--check` was passed). _Black_
  28 will still emit messages on stderr but that shouldn't affect your use case.
  29
  30 This can be used for example with PyCharm's or IntelliJ's
  31 [File Watchers](https://www.jetbrains.com/help/pycharm/file-watchers.html).