diff options
| author | Dan Allen <dan.j.allen@gmail.com> | 2023-04-30 23:53:17 -0600 |
|---|---|---|
| committer | Dan Allen <dan.j.allen@gmail.com> | 2023-05-01 01:37:50 -0600 |
| commit | be83bfbfb17e7ed57a6acb2a79962c16e4bc5b07 (patch) | |
| tree | 440bd020c4bf2182580eda130a86c095ef0fb8b9 | |
| parent | 612ba6a950cc5c67d031eb94ef8d7d0228c6abff (diff) | |
recommend overriding the default external and internal character encodings instead of messing with the active code page
| -rw-r--r-- | README.adoc | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/README.adoc b/README.adoc index 3d90f72e..777a420a 100644 --- a/README.adoc +++ b/README.adoc @@ -137,13 +137,15 @@ Asciidoctor works on Linux, macOS and Windows and requires one of the following [CAUTION] ==== If you're using a non-English Windows environment, you may bump into an `Encoding::UndefinedConversionError` when invoking Asciidoctor. -To solve this issue, we recommend changing the active code page in your console to UTF-8: +To solve this issue, we recommend overriding the default external and internal character encodings to `utf-8`. +You can do so by setting the `RUBYOPT` environment variable as follows: - chcp 65001 + RUBYOPT="-E utf-8:utf-8" + +Once you make this change, all your Unicode headaches should be behind you. -Once you make this change, all your Unicode headaches will be behind you. If you're using an IDE like Eclipse, make sure you set the encoding to UTF-8 there as well. -Asciidoctor works best when you use UTF-8 everywhere. +Asciidoctor works best when you use UTF-8 as the default encoding. ==== == Installation |