From e4eba7cce9358d9447f3dee1aa5357b418bc34b5 Mon Sep 17 00:00:00 2001 From: phlax Date: Thu, 29 Apr 2021 00:10:46 +0100 Subject: [PATCH] docs: Improve style for inline literals and update contrib guidance (#16194) Signed-off-by: Ryan Northey Signed-off-by: Gokul Nair --- api/CONTRIBUTING.md | 3 +-- docs/root/_static/css/envoy.css | 8 ++++++++ 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/api/CONTRIBUTING.md b/api/CONTRIBUTING.md index 847cdf74dc55..a1e61a7072c4 100644 --- a/api/CONTRIBUTING.md +++ b/api/CONTRIBUTING.md @@ -72,7 +72,6 @@ The following are some general guidelines around documentation. // [#comment:TODO(mattklein123): Do something cooler] string foo_field = 3; ``` - -* Prefer *italics* for emphasis as `backtick` emphasis is somewhat jarring in our Sphinx theme. +* Please use *italics* (enclosed in asterisks `*emphasized word*`) for emphasis and `inline literals` for code quotation (enclosed in *double* backticks ` ``code`` `). * All documentation is expected to use proper English grammar with proper punctuation. If you are not a fluent English speaker please let us know and we will help out. diff --git a/docs/root/_static/css/envoy.css b/docs/root/_static/css/envoy.css index ade3cb1b16a1..4cc8d11cfdf3 100644 --- a/docs/root/_static/css/envoy.css +++ b/docs/root/_static/css/envoy.css @@ -28,3 +28,11 @@ table.docutils div.line-block { .rst-content .sidebar { clear: right; } + +/* make code.literals more muted - dont use red! */ +.rst-content code.literal { + color: #555; + background-color: rgba(27, 31, 35, 0.05); + padding: 2px 2px; + border: solid #eee 1px; +}