X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/9e3175428470403d01cdee9c710d5d38e8610860..858225d34dc49ca353f9e573dd82dd5845766115:/docs/index.rst diff --git a/docs/index.rst b/docs/index.rst index 7a0995b..f03d247 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,7 +4,7 @@ The uncompromising code formatter ================================= -By using *Black*, you agree to cease control over minutiae of +By using *Black*, you agree to cede control over minutiae of hand-formatting. In return, *Black* gives you speed, determinism, and freedom from `pycodestyle` nagging about formatting. You will save time and mental energy for more important matters. @@ -14,9 +14,11 @@ possible. Blackened code looks the same regardless of the project you're reading. Formatting becomes transparent after a while and you can focus on the content instead. +Try it out now using the `Black Playground `_. + .. note:: - `Black is an early pre-release `_. + `Black is beta `_. Testimonials @@ -26,7 +28,7 @@ Testimonials *Black is opinionated so you don't have to be.* -**Hynek Schlawack**, creator of `attrs `_, core +**Hynek Schlawack**, creator of `attrs `_, core developer of Twisted and CPython: *An auto-formatter that doesn't suck is all I want for Xmas!* @@ -46,15 +48,24 @@ Contents .. toctree:: :maxdepth: 2 - usage - technical_philosophy - contributing - changelog - + installation_and_usage + the_black_code_style + pyproject_toml + compatible_configs + editor_integration + blackd + black_primer + version_control_integration + github_actions + ignoring_unmodified_files + contributing_to_black + show_your_style + change_log + reference/reference_summary + authors Indices and tables ================== * :ref:`genindex` -* :ref:`modindex` * :ref:`search`