diff options
| author | Dan Allen <dan.j.allen@gmail.com> | 2023-04-30 23:55:12 -0600 |
|---|---|---|
| committer | Dan Allen <dan.j.allen@gmail.com> | 2023-05-01 01:37:56 -0600 |
| commit | 4c56ff39d2c7e1834372aee1b69b587807d22c48 (patch) | |
| tree | 98a456672787151e1e50b3c75cc95ea3390eb71c | |
| parent | be83bfbfb17e7ed57a6acb2a79962c16e4bc5b07 (diff) | |
add system encoding section to system requirements page in docs
| -rw-r--r-- | README.adoc | 2 | ||||
| -rw-r--r-- | docs/modules/install/pages/supported-platforms.adoc | 16 |
2 files changed, 17 insertions, 1 deletions
diff --git a/README.adoc b/README.adoc index 777a420a..53b85341 100644 --- a/README.adoc +++ b/README.adoc @@ -145,7 +145,7 @@ You can do so by setting the `RUBYOPT` environment variable as follows: Once you make this change, all your Unicode headaches should 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 as the default encoding. +Asciidoctor is optimized to work with UTF-8 as the default encoding. ==== == Installation diff --git a/docs/modules/install/pages/supported-platforms.adoc b/docs/modules/install/pages/supported-platforms.adoc index 140bf469..e66d199c 100644 --- a/docs/modules/install/pages/supported-platforms.adoc +++ b/docs/modules/install/pages/supported-platforms.adoc @@ -48,3 +48,19 @@ Windows Server 2019 |=== While the community tests Asciidoctor on a variety of Linux distributions, it's only officially tested on Ubuntu and Fedora. + +== System encoding + +Asciidoctor assumes you're using UTF-8 encoding. +To minimize encoding problems, make sure the default encoding of your system is set to UTF-8. + +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 overriding the default external and internal character encodings to `utf-8`. +You can do so by setting the `RUBYOPT` environment variable as follows: + + RUBYOPT="-E utf-8:utf-8" + +Once you make this change, all your Unicode headaches should be behind you. + +If you're using an IDE like Eclipse, make sure you set the encoding to UTF-8 there as well. +Asciidoctor is optimized to work with UTF-8 as the default encoding. |