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

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:

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