]> git.madduck.net Git - etc/vim.git/blobdiff - docs/usage_and_configuration/black_as_a_server.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:

Reorganize docs v2 (GH-2174)
[etc/vim.git] / docs / usage_and_configuration / black_as_a_server.md
similarity index 98%
rename from docs/blackd.md
rename to docs/usage_and_configuration/black_as_a_server.md
index c8058ee7c63ed2e567f0dc51e72cf14e27314598..0c0382b3e50487650e625c3808b37da233dd954f 100644 (file)
@@ -1,10 +1,10 @@
-## blackd
+# Black as a server (blackd)
 
 `blackd` is a small HTTP server that exposes _Black_'s functionality over a simple
 protocol. The main benefit of using it is to avoid the cost of starting up a new _Black_
 process every time you want to blacken a file.
 
-### Usage
+## Usage
 
 `blackd` is not packaged alongside _Black_ by default because it has additional
 dependencies. You will need to execute `pip install black[d]` to install it.
@@ -36,7 +36,7 @@ blackd --bind-port 9090 &  # or let blackd choose a port
 curl -s -XPOST "localhost:9090" -d "print('valid')"
 ```
 
-### Protocol
+## Protocol
 
 `blackd` only accepts `POST` requests at the `/` path. The body of the request should
 contain the python source code to be formatted, encoded according to the `charset` field