是否需要直接在WordPress編輯器中顯示文檔？本文探討了最佳方法，利用降級(jí)來(lái)簡(jiǎn)化文檔管理和本地化。

儘管React組件和HTML似乎直觀，但它們很快就會(huì)變得笨拙且難以維持廣泛的文檔。從上一篇文章中考慮此示例以模式顯示文檔：

 const cachecontroldescription =（）=> {
  返回 （
    <p>緩存控制標(biāo)頭將包含請(qǐng)求中涉及的所有字段/指令的最小最大值，或者<code>no-store if the max-age is 0</code>
  ）
}</p>

Markdown提供了更清潔的解決方案。以上可以重構(gòu)為Markdown文件（ /docs/cache-control.md ）：

緩存控制標(biāo)頭將包含請(qǐng)求中涉及的所有字段/指令的最小最大值值，如果最大值為0

Markdown vs. HTML：優(yōu)勢(shì)和缺點(diǎn)

Markdown簡(jiǎn)化了該過(guò)程，但缺乏內(nèi)置的本地化支持，與React組件不同，該組件允許使用Pot Files輕鬆翻譯。由於本地化至關(guān)重要，我們將解決此限制。本文旨在實(shí)現(xiàn)兩個(gè)關(guān)鍵目標(biāo)：

1. 利用Markdown在WordPress編輯器塊中進(jìn)行文檔。
2. 根據(jù)用戶的語(yǔ)言實(shí)施文檔翻譯。

加載標(biāo)記內(nèi)容

使用/docs/cache-control.md創(chuàng)建，我們可以導(dǎo)入並渲染其HTML轉(zhuǎn)換的內(nèi)容：

從'../docs/cache-control.md'導(dǎo)入cachecontroldocumentation;

const cachecontroldescription =（）=> {
  返回 （
    <div dangerouslysetinnerhtml="{{" __html: cachecontroldocumentation></div>
  ）；
}

這依賴於WebPack，WordPress編輯器的Core Module Bundler（版本4.42）。我們將自定義WebPack的配置來(lái)處理Markdown和HTML加載程序。

在該塊的root上創(chuàng)建webpack.config.js ：

 const defaultConfig = require（'@wordpress/scripts/config/webpack.config'）;

Module.exports = {
  ... DefaultConfig，
  模塊： {
    ... defaultConfig.module，
    規(guī)則：[
      ... DefaultConfig.module.rules，
      {
        測(cè)試： /\ .md$/，
        使用： [
          {loader：“ html-loader”}，
          {Loader：“ Markdown-Loader”}
        這是給出的
      }
    ]，，
  }，，
};

安裝必要的軟件包：

 NPM安裝-SAVE-DEV MARKDOWN-LOADER HTML-LOADER

對(duì)於改進(jìn)的組織，請(qǐng)?zhí)砑右粋€(gè)WebPack別名（ @docs指向/docs ）：

 const路徑= require（'path'）;
config.resolve.alias ['@docs'] = path.resolve（process.cwd（），'docs/'）;

現(xiàn)在簡(jiǎn)化導(dǎo)入到：

從'@docs/cache-control.md'導(dǎo)入cachecontroldocumentation;

本地文檔

由於直接的Markdown譯出不可行，因此我們創(chuàng)建特定於語(yǔ)言的標(biāo)記文件：

• /docs/en/cache-control.md
• /docs/fr/cache-control.md
• /docs/zh/cache-control.md等。

這種方法還可以處理特定於區(qū)域的變化（例如， /docs/en_US/cache-control.md en_us/cache-control.md）。

檢索用戶語(yǔ)言

用戶的語(yǔ)言是使用get_locale()獲得的，並解析以提取語(yǔ)言代碼：

函數(shù)get_locale_language（）：字符串{
  $ localeparts = Explode（'_'，get_locale（））;
  返回$ localeparts [0];
}

此語(yǔ)言代碼通過(guò)wp_localize_script()傳遞給塊：

 wp_localize_script（
  $ blockscriptregistrationname，
  “ graphqlapicachecontol”，
  [
    'userLang'=> get_locale_language（），
  這是給出的
）；

現(xiàn)在可以在塊中訪問(wèn)window.graphqlApiCacheControl.userLang 。

動(dòng)態(tài)導(dǎo)入

由於僅在運(yùn)行時(shí)知道用戶的語(yǔ)言，因此我們使用動(dòng)態(tài)導(dǎo)入：

 const lang = window.graphqlapicachecontrol.userlang;
import（`@docs/$ {lang}/cache-control.md`）。
  // ...
}）;

內(nèi)容可通過(guò)obj.default訪問(wèn)：

 const cachecontrolcontent = import（`@docs/$ {lang}/cache-control.md`）。然後（obj => obj.default）;

這封裝在getMarkdownContent函數(shù)中：

 const getMarkDownContent =（filename，lang）=> {
  返回導(dǎo)入（/ * webpackchunkname：“ doc/[request]” */`@docs/$ {lang}/$ {filename} .md`）
    。
};

/* webpackChunkName: "docs/[request]" */評(píng)論確保有組織的塊管理。

設(shè)定公共道路

publicPath對(duì)於WebPack來(lái)說(shuō)至關(guān)重要，以找到動(dòng)態(tài)加載的塊?？梢詫?duì)此進(jìn)行硬編碼，通過(guò)環(huán)境變量設(shè)置或在運(yùn)行時(shí)傳遞。在此示例中，我們將通過(guò)它：

 $ blockpublicpath = plugin_dir_url（__文件__）。 '/blocks/cache-control/build/';
wp_localize_script（
  $ blockscriptregistrationname，
  “ graphqlapicachecontol”，
  [
    // ...
    'publicPath'=> $ blockpublicpath，
  這是給出的
）；

然後將其設(shè)置在JavaScript方面：

 __webpack_public_path__ = window.graphqlapicachecontrol.publicpath;

默認(rèn)語(yǔ)言後備

後備機(jī)制處理缺失的翻譯：

 const getmarkDownContentorusedEfault =（文件名，defaultlang，lang）=> {
  返回getmarkDownContent（文件名，lang）
    .catch（err => getMarkDownContent（文件名，defaultLang））;
};

與模態(tài)集成

最後，將降價(jià)內(nèi)容集成到模式中：

從'@wordpress/element'import {usestate，useeffect};
// ...其他進(jìn)口

const cachecontrolcontentmodal =（props）=> {
  // ...
  const [page，setPage] = usestate（[]）;

  useeffect（（）=> {
    getMarkDownContentorusedEfault（文件名，defaultlang，lang）。
      setPage（value）;
    }）;
  }，[]）;

  返回 （
    <contentmodal content="{page}"></contentmodal>
  ）；
};

這種方法在WordPress編輯器中提供了強(qiáng)大，可維護(hù)和局部的文檔系統(tǒng)。

以上是在WordPress塊編輯器中使用Markdown和本地化的詳細(xì)內(nèi)容。更多資訊請(qǐng)關(guān)注PHP中文網(wǎng)其他相關(guān)文章！