Include some comment about non-English texts

[deeplook]

Great tool! It might be useful to add a comment like the following made by Grok.com for those who hope this would work on non-English texts as well.

The Obsidian Text Analysis plugin, as described on its GitHub repository, is designed to provide real-time feedback on text readability, structure, and style through various metrics such as word counts, syllable counts, and established readability indices (e.g., Flesch Reading Ease, Gunning Fog Index).

Regarding compatibility with non-English texts, the plugin would function partially but with significant limitations. Basic features, including character counts, word counts (based on Unicode words), sentence counts, and paragraph counts, are language-agnostic and should operate effectively across different languages, as they rely on general text parsing rather than language-specific rules. However, advanced metrics that depend on syllable detection—such as average syllables per word, percentage of difficult words, and several readability scores (e.g., Flesch-Kincaid Grade Level, SMOG Index)—are explicitly optimized for English. The syllable counting algorithm is developed for English and may produce inaccurate results for other languages.

Additionally, most readability indicators are primarily calibrated for English texts and may not yield reliable or comparable outcomes for non-English content due to differences in linguistic structures, vocabulary complexity, and syntax. One exception is the Lix Readability Formula, which originates from Swedish and could potentially apply to similar languages, though this is not guaranteed for all non-English cases.

In summary, while the plugin can process non-English texts for fundamental statistics, its core analytical features are not fully compatible, potentially leading to misleading assessments. If your use case involves non-English content, consider testing it empirically or exploring alternative tools tailored to specific languages.