]> git.madduck.net Git - etc/vim.git/blob - docs/usage_and_configuration/index.rst

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Bump actions/checkout from 2 to 3 (#2909)
[etc/vim.git] / docs / usage_and_configuration / index.rst
1 Usage and Configuration
2 =======================
3
4 .. toctree::
5   :hidden:
6
7   the_basics
8   file_collection_and_discovery
9   black_as_a_server
10   black_docker_image
11
12 Sometimes, running *Black* with its defaults and passing filepaths to it just won't cut
13 it. Passing each file using paths will become burdensome, and maybe you would like
14 *Black* to not touch your files and just output diffs. And yes, you *can* tweak certain
15 parts of *Black*'s style, but please know that configurability in this area is
16 purposefully limited.
17
18 Using many of these more advanced features of *Black* will require some configuration.
19 Configuration that will either live on the command line or in a TOML configuration file.
20
21 This section covers features of *Black* and configuring *Black* in detail:
22
23 - :doc:`The basics <./the_basics>`
24 - :doc:`File collection and discovery <file_collection_and_discovery>`
25 - :doc:`Black as a server (blackd) <./black_as_a_server>`
26 - :doc:`Black Docker image <./black_docker_image>`