本教程详细阐述了如何利用RemarkJS的“内容类”功能，在单个HTML+Markdown文件中实现多语言演示文稿的国际化。通过为不同语言内容标记特定的CSS类，结合CSS样式控制和JavaScript逻辑，可以高效地在不同语言版本之间切换，从而避免多文件同步的难题，确保内容的一致性与维护便捷性。
在构建多语言演示文稿时，开发者常常面临一个挑战：如何高效地管理和同步不同语言版本的内容。尤其当演示文稿基于html和markdown（如使用remarkjs）时，为每种语言创建单独的文件（例如slides_fr.html和slides_en.html）会导致内容更新不同步、维护成本高昂的问题。remarkjs提供了一个优雅的解决方案——“内容类”（content classes），它允许我们在单个markdown源文件中集成多种语言的内容，并通过css和javascript实现动态切换。
RemarkJS内容类（Content Classes）解析
RemarkJS的“内容类”是其Markdown扩展语法的一部分，旨在为Markdown中的文本片段应用自定义的CSS类。其基本语法为：.className[文本内容]。
当RemarkJS解析包含这种语法的Markdown时，它会将其转换为带有指定CSS类的标签（或其他合适的HTML元素，取决于上下文）。例如：
- Markdown: .highlight[重要信息]
- HTML输出: 重要信息
这一特性是实现多语言的关键。我们可以为每种语言定义一个独特的CSS类（例如lang_en代表英语，lang_fr代表法语），然后将不同语言的文本分别包裹在对应的类中。
多语言内容的标记实践
利用内容类，我们可以将所有语言版本的文本内容都写在同一个Markdown源文件中。以下是一个示例，展示如何在RemarkJS的
立即学习“前端免费学习笔记（深入）”；
.lang_en[# First Slide] .lang_fr[# Première Diapositive] .lang_en[Welcome to my presentation on **Internationalization** with RemarkJS!] .lang_fr[欢迎观看我关于RemarkJS**国际化**的演示文稿！] --- .lang_en[# Second Slide] .lang_fr[# Seconde Diapositive] .lang_en[This approach uses RemarkJS **Content Classes**.] .lang_fr[这种方法利用了RemarkJS的**内容类**功能。] .lang_en[It allows you to keep all language versions in a **single Markdown file**.] .lang_fr[它允许您将所有语言版本保存在**一个Markdown文件**中。]
通过这种方式，所有语言的内容都集中在一个文件中，极大地简化了内容的管理和未来的同步更新。
CSS与JavaScript实现语言切换
内容标记完成后，我们需要通过CSS规则和JavaScript逻辑来控制不同语言内容的显示与隐藏。
CSS样式规则
首先，设置CSS规则以默认隐藏所有带有语言前缀的文本内容，然后仅显示当前选定语言的内容。
/* 默认隐藏所有带有 lang_ 前缀的元素 */ [class^="lang_"] { display: none; } /* 示例：默认显示英语内容。 当JavaScript未加载或执行前，用户将看到此语言。 */ .lang_en { display: inline; /* 或 block，取决于文本的原始显示类型 */ } /* 语言切换按钮的基本样式，可选 */ .lang-switcher { position: absolute; top: 10px; right: 10px; z-index: 100; /* 确保按钮在幻灯片之上 */ } .lang-switcher button { margin-left: 5px; padding: 5px 10px; cursor: pointer; border: 1px solid #ccc; background-color: #f0f0f0; border-radius: 3px; } .lang-switcher button:hover { background-color: #e0e0e0; }
JavaScript语言切换逻辑
JavaScript负责监听用户的语言选择，并动态地更新页面元素的显示状态。这通常涉及一个语言选择器（如按钮或下拉菜单）和一个处理切换逻辑的函数。
function setLanguage(langCode) { // 隐藏所有语言内容 document.querySelectorAll('[class^="lang_"]').forEach(el => { el.style.display = 'none'; }); // 显示指定语言的内容 document.querySelectorAll(`.lang_${langCode}`).forEach(el => { // 将 display 属性设置为空字符串，让元素恢复其默认的 display 行为 // 例如，<span>会是 inline，<h1>会是 block el.style.display = ''; }); // 可选：更新UI以反映当前语言 // 例如，高亮当前选中的语言按钮 document.querySelectorAll('.lang-switcher button').forEach(button => { if (button.id === `lang${langCode.charAt(0).toUpperCase() + langCode.slice(1)}`) { button.style.fontWeight = 'bold'; button.style.backgroundColor = '#d0d0d0'; } else { button.style.fontWeight = 'normal'; button.style.backgroundColor = '#f0f0f0'; } }); } // 页面加载完成后执行初始化和事件绑定 document.addEventListener('DOMContentLoaded', () => { // 默认设置语言（例如，从URL参数、浏览器设置或默认值获取） // 这里我们默认显示英语 setLanguage('en'); // 为语言切换按钮添加事件监听器 document.getElementById('langEn').addEventListener('click', () => setLanguage('en')); document.getElementById('langFr').addEventListener('click', () => setLanguage('fr')); });
整合示例
以下是一个将上述概念整合到完整RemarkJS演示文稿中的HTML结构示例：
<!DOCTYPE html> <html> <head> <title>国际化RemarkJS演示文稿</title> <meta charset="utf-8"> <style> /* RemarkJS幻灯片内容的基本样式 */ .remark-slide-content { font-family: 'Droid Serif'; font-size: 20px; padding: 1em 2em; } /* 语言切换样式 */ [class^="lang_"] { display: none; /* 默认隐藏所有语言内容 */ } /* 默认显示英语内容，确保在JS加载前有内容可见 */ .lang_en { display: inline; } /* 语言切换按钮样式 */ .lang-switcher { position: absolute; top: 10px; right: 10px; z-index: 100; } .lang-switcher button { margin-left: 5px; padding: 5px 10px; cursor: pointer; border: 1px solid #ccc; background-color: #f0f0f0; border-radius: 3px; } .lang-switcher button:hover { background-color: #e0e0e0; } </style> </head> <body> <!-- RemarkJS Markdown 内容 --> <textarea id="source"> .lang_en[# First Slide] .lang_fr[# Première Diapositive] .lang_en[Welcome to my presentation on **Internationalization** with RemarkJS!] .lang_fr[欢迎观看我关于RemarkJS**国际化**的演示文稿！] --- .lang_en[# Second Slide] .lang_fr[# Seconde Diapositive] .lang_en[This approach uses RemarkJS **Content Classes**.] .lang_fr[这种方法利用了RemarkJS的**内容类**功能。] .lang_en[It allows you to keep all language versions in a **single Markdown file**.] .lang_fr[它允许您将所有语言版本保存在**一个Markdown文件**中。] </textarea> <!-- 语言切换按钮 --> <div class="lang-switcher"> <button id="langEn">English</button> <button id="langFr">Français</button> </div> <!-- RemarkJS 库 --> <script src="https://remarkjs.com/downloads/remark-latest.min.js"></script> <script> // 初始化 RemarkJS 幻灯片 var slideshow = remark.create(); // 语言切换函数 function setLanguage(langCode) { document.querySelectorAll('[class^="lang_"]').forEach(el => { el.style.display = 'none'; }); document.querySelectorAll(`.lang_${langCode}`).forEach(el => { el.style.display = ''; // 恢复元素默认的 display 属性 }); // 更新按钮样式 document.querySelectorAll('.lang-switcher button').forEach(button => { if (button.id === `lang${langCode.charAt(0).toUpperCase() + langCode.slice(1)}`) { button.style.fontWeight = 'bold'; button.style.backgroundColor = '#d0d0d0'; } else { button.style.fontWeight = 'normal'; button.style.backgroundColor = '#f0f0f0'; } }); } // 页面加载后设置默认语言并绑定事件 document.addEventListener('DOMContentLoaded', () => { setLanguage('en'); // 默认显示英语 document.getElementById('langEn').addEventListener('click', () => setLanguage('en')); document.getElementById('langFr').addEventListener('click', () => setLanguage('fr')); }); </script> </body> </html>
注意事项
- 粒度选择： 内容类可以应用于任何粒度的文本，从单个单词到整个段落甚至幻灯片。根据内容的复杂性和重用性，合理选择标记的粒度。
- 默认语言： 在CSS中设置一个默认显示的语言（如.lang_en { display: inline; }），以确保在JavaScript加载或执行失败时，用户至少能看到一个版本的幻灯片。
- 性能考量： 对于包含大量文本和多种语言的超大型文档，频繁的DOM操作可能会对性能产生轻微影响。但对于一般的演示文稿，这种影响通常
评论（已关闭）
评论已关闭