diff options
| author | Edward Thomson <ethomson@github.com> | 2021-11-16 00:30:01 +0300 |
|---|---|---|
| committer | Gar <gar+gh@danger.computer> | 2021-11-16 00:40:07 +0300 |
| commit | 9868e7eb451c3e13c99af19314300415e1317ab5 (patch) | |
| tree | 8363d21312dbf1131bcbc09defb2702a7e43fce8 /docs | |
| parent | 201df1760eb1054777eeea0c118fdb33e95e7ef6 (diff) | |
docs: turn off smart quotes, update doctype and charset
* When rendering HTML documentation, don't use smart quotes because they're icky and hard to copy/paste.
* Add a <!DOCTYPE html> and a <meta charset="utf-8"> to be good HTML citizens.
PR-URL: https://github.com/npm/cli/pull/4046
Credit: @ethomson
Close: #4046
Reviewed-by: @wraithgar
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/dockhand.js | 2 | ||||
| -rw-r--r-- | docs/template.html | 2 |
2 files changed, 3 insertions, 1 deletions
diff --git a/docs/dockhand.js b/docs/dockhand.js index e2b9111ed..77d3d63c0 100644 --- a/docs/dockhand.js +++ b/docs/dockhand.js @@ -152,7 +152,7 @@ async function renderFile (childPath) { // Render the markdown into an HTML snippet using a GFM renderer. const content = cmark.renderHtmlSync(md, { - smart: true, + smart: false, githubPreLang: true, strikethroughDoubleTilde: true, unsafe: false, diff --git a/docs/template.html b/docs/template.html index fea1eb949..be3bafd61 100644 --- a/docs/template.html +++ b/docs/template.html @@ -1,5 +1,7 @@ +<!DOCTYPE html> <html> <head> +<meta charset="utf-8"> <title>{{ title }}</title> <style> body { |