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:18 -0600 |
| commit | 867866575fb97947b037d47850914985686387f0 (patch) | |
| tree | 7bae2bc443b4b26afcbf612ee409add042d13f3a /docs | |
| parent | 25d4a84119670a4681edcc78f53844f218f020de (diff) | |
add system encoding section to system requirements page in docs
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/modules/install/pages/supported-platforms.adoc | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/modules/install/pages/supported-platforms.adoc b/docs/modules/install/pages/supported-platforms.adoc index 6ad1a4b8..05282163 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. |