doc: add http highlight grammar

Prior to this commit, http request message code blocks in Markdown files were not being highlighted correctly. This has been corrected by adding the new grammar to the bundle, removing the CRLFs (`\r\n`) from these code samples, adding a reminder to re-add them, and tuning the syntax theme to support attribute highlighting. PR-URL: #33785 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Matteo Collina <[email protected]>
nodejs · Jul 14, 2020 · 726771a · 726771a
1 parent c066c3d
commit 726771a
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 12 deletions.
diff --git a/doc/api/http.md b/doc/api/http.md
@@ -2090,13 +2090,13 @@ added: v0.1.90
 
 **Only valid for request obtained from [`http.Server`][].**
 
-Request URL string. This contains only the URL that is
-present in the actual HTTP request. If the request is:
+Request URL string. This contains only the URL that is present in the actual
+HTTP request. If the request is (remember, each header line ends with `\r\n`
+plus a final `\r\n` after the last one indicating the end of the header):
 
 ```http
-GET /status?name=ryan HTTP/1.1\r\n
-Accept: text/plain\r\n
-\r\n
+GET /status?name=ryan HTTP/1.1
+Accept: text/plain
 ```
 
 To parse the URL into its parts:

diff --git a/doc/api/http2.md b/doc/api/http2.md
@@ -3027,13 +3027,13 @@ added: v8.4.0
 
 * {string}
 
-Request URL string. This contains only the URL that is
-present in the actual HTTP request. If the request is:
+Request URL string. This contains only the URL that is present in the actual
+HTTP request. If the request is (remember, each header line ends with `\r\n`
+plus a final `\r\n` after the last one indicating the end of the header):
 
 ```http
-GET /status?name=ryan HTTP/1.1\r\n
-Accept: text/plain\r\n
-\r\n
+GET /status?name=ryan HTTP/1.1
+Accept: text/plain
 ```
 
 Then `request.url` will be:

diff --git a/doc/api_assets/README.md b/doc/api_assets/README.md
@@ -2,14 +2,15 @@
 
 ## highlight.pack.js
 
-_Generated by [highlightjs.org/download][] on 2020-05-16._
+_Generated by [highlightjs.org/download][] on 2020-06-07._
 
 Grammars included in the custom bundle:
 
 * Bash
 * C
 * C++
 * CoffeeScript
+* HTTP
 * JavaScript
 * JSON
 * Markdown

diff --git a/doc/api_assets/highlight.pack.js b/doc/api_assets/highlight.pack.js
diff --git a/doc/api_assets/hljs.css b/doc/api_assets/hljs.css
@@ -7,6 +7,7 @@
   color: #333;
 }
 
+.hljs-attribute,
 .hljs-keyword {
   color: #338;
 }