diff options
| author | Guillaume Grossetie <ggrossetie@gmail.com> | 2022-08-22 20:47:27 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-08-22 12:47:27 -0600 |
| commit | d72fe54346aa6963ae835f48681fa1ed917fb3fe (patch) | |
| tree | 4896c6906efb3ee81aebde948580dd46767eb7c4 /docs/modules/syntax-highlighting | |
| parent | 81e3e772f1294f85a5be7d34d06e132494c44e5b (diff) | |
proofread documentation (PR #4336)
Diffstat (limited to 'docs/modules/syntax-highlighting')
| -rw-r--r-- | docs/modules/syntax-highlighting/pages/index.adoc | 2 | ||||
| -rw-r--r-- | docs/modules/syntax-highlighting/pages/pygments.adoc | 4 |
2 files changed, 3 insertions, 3 deletions
diff --git a/docs/modules/syntax-highlighting/pages/index.adoc b/docs/modules/syntax-highlighting/pages/index.adoc index 2d730230..d27fd66f 100644 --- a/docs/modules/syntax-highlighting/pages/index.adoc +++ b/docs/modules/syntax-highlighting/pages/index.adoc @@ -46,7 +46,7 @@ There are benefits and drawbacks of each type. The benefit of a client-side syntax highlighter is that does not require installing any additional libraries. It also makes conversion faster and makes it produce smaller output since the syntax highlighting is deferred until page load. The main drawback is that callouts in the source block can be mangled by the syntax highlighter or confuse it. -The benefits of a build-time syntax highlighter is that you have more control over syntax highlighting and can enable additional features such as line numbers and line highlighting. +The benefits of a build-time syntax highlighter are that you have more control over syntax highlighting and can enable additional features such as line numbers and line highlighting. The main drawback is that it requires installing an extra library, it slows down conversion, and causes the output to be larger. You should try each syntax highlighter and find the one that works best for you. diff --git a/docs/modules/syntax-highlighting/pages/pygments.adoc b/docs/modules/syntax-highlighting/pages/pygments.adoc index 605a8df9..1d5fa99f 100644 --- a/docs/modules/syntax-highlighting/pages/pygments.adoc +++ b/docs/modules/syntax-highlighting/pages/pygments.adoc @@ -16,7 +16,7 @@ It comes bundled with the pygments.rb gem. IMPORTANT: You must have Python installed to use pygments.rb. -The version of Python required depends on which pygments.rb release you using: +The version of Python required depends on which pygments.rb release you're using: * pygments.rb 1.x requires Python 2. Check that you have a `python2` (Linux), `python` (macOS), or `py -2` (Windows) executable on your PATH. @@ -107,7 +107,7 @@ This command ensures that you are invoking the `pygmentize` command from the Pyg If you're using pygments.rb 1.x, you may need to adjust the timeout. This configuration step is not necessary if you're using pygments.rb 2.x with Python 3. -Since Pygments is an external program, the call to that command in pygments.rb 1.x is managed by a timeout to safe-guard against a hanging process. +Since Pygments is an external program, the call to that command in pygments.rb 1.x is managed by a timeout to safeguard against a hanging process. By default, this timeout is 8 seconds. If you discover that the call is failing to complete within this timeout period, you can increase the timeout (in seconds) by setting the `MENTOS_TIMEOUT` environment variable. |