Menggunakan Markdown dan Penyetempatan di Editor Blok WordPress

Perlu memaparkan dokumentasi secara langsung dalam editor WordPress? Artikel ini meneroka pendekatan yang optimum, memanfaatkan markdown untuk pengurusan dokumentasi dan penyetempatan dokumentasi yang diperkemas.

Walaupun komponen React dan HTML mungkin kelihatan intuitif, mereka dapat dengan cepat menjadi sukar dan sukar untuk dikekalkan untuk dokumentasi yang luas. Pertimbangkan contoh ini dari artikel sebelumnya yang menunjukkan dokumentasi dalam modal:

 const cacheControldescription = () => {
  kembali (
    <p>Pengepala kawalan cache akan mengandungi nilai maksimum maksimum minimum dari semua medan/arahan yang terlibat dalam permintaan, atau <code>no-store if the max-age is 0</code>
  )
}</p>

Markdown menawarkan penyelesaian yang lebih bersih. Di atas boleh diubahsuai ke dalam fail markdown ( /docs/cache-control.md ):

 Pengepala kawalan cache akan mengandungi nilai maksimum maksimum minimum dari semua bidang/arahan yang terlibat dalam permintaan, atau `no-store` jika max-usia 0

Markdown vs HTML: Kelebihan dan Kekurangan

Markdown memudahkan proses, tetapi tidak mempunyai sokongan penyetempatan terbina dalam, tidak seperti komponen React yang membolehkan terjemahan mudah menggunakan fail periuk. Oleh kerana penyetempatan adalah penting, kami akan menangani batasan ini. Artikel ini bertujuan untuk mencapai dua objektif utama:

1. Menggunakan markdown untuk dokumentasi dalam blok editor WordPress.
2. Melaksanakan terjemahan dokumentasi berdasarkan bahasa pengguna.

Memuatkan kandungan markdown

Dengan /docs/cache-control.md dicipta, kami boleh mengimport dan menjadikan kandungan HTML-convertednya:

 import cachecontroldocumentation dari '../docs/cache-control.md';

const cacheControldescription = () => {
  kembali (
    <div dangerouslysetinnerhtml="{{" __html: cachecontroldocumentation></div>
  );
}

Ini bergantung pada Webpack, modul modul teras editor WordPress (versi 4.42). Kami akan menyesuaikan konfigurasi WebPack untuk mengendalikan markdown dan pemuat HTML.

Buat webpack.config.js di akar blok:

 const defaultConfig = memerlukan ('@wordpress/scripts/config/webpack.config');

modul.exports = {
  ... defaultconfig,
  modul: {
    ... defaultconfig.module,
    Kaedah: [
      ... defaultconfig.module.rules,
      {
        Ujian: /\.md$/,
        Gunakan: [
          {loader: "html-loader"},
          {loader: "markdown-loader"}
        ]
      }
    ],
  },
};

Pasang pakej yang diperlukan:

 Pemasangan NPM--Save-Dev Markdown-Loader HTML-Loader

Untuk organisasi yang lebih baik, tambahkan alias webpack ( @docs menunjuk ke /docs ):

 const Path = memerlukan ('jalan');
config.resolve.alias ['@docs'] = path.resolve (process.cwd (), 'docs/');

Sekarang import mudah untuk:

 import CacheControldocumentation dari '@docs/cache-control.md';

Dokumentasi penyetempatan

Oleh kerana terjemahan markdown langsung tidak boleh dilaksanakan, kami membuat fail markdown khusus bahasa:

• /docs/en/cache-control.md
• /docs/fr/cache-control.md
• /docs/zh/cache-control.md dll.

Pendekatan ini juga boleh mengendalikan variasi khusus rantau (misalnya, /docs/en_US/cache-control.md ).

Mengambil semula bahasa pengguna

Bahasa pengguna diperoleh menggunakan get_locale() dan dihuraikan untuk mengekstrak kod bahasa:

 fungsi get_locale_language (): string {
  $ localeparts = explode ('_', get_locale ());
  kembali $ localeparts [0];
}

Kod bahasa ini diluluskan ke blok melalui wp_localize_script() :

 wp_localize_script (
  $ blockscriptregistrationName,
  'GraphqlapacacheControl',
  [
    'userlang' => get_locale_language (),
  ]
);

Kini boleh diakses di blok sebagai window.graphqlApiCacheControl.userLang .

Import dinamik

Oleh kerana bahasa pengguna hanya diketahui semasa runtime, kami menggunakan import dinamik:

 const lang = window.graphqlapacachecontrol.userlang;
import (`@docs/$ {lang}/cache-control.md`) .then (module => {
  // ...
});

Kandungan diakses melalui obj.default :

 const CacheControlContent = import (`@docs/$ {lang}/cache-control.md`) .theTHen (obj => obj.default);

Ini terkandung dalam fungsi getMarkdownContent :

 const getmarkdowncontent = (fileName, lang) => {
  Kembali Import (/ * WebPackChunkName: "Docs/[Request]" */`@docs/$ {lang}/$ {fileName} .md`)
    .the (obj => obj.default);
};

The /* webpackChunkName: "docs/[request]" */ Comment Memastikan Pengurusan Bahagian Terorganisir.

Menetapkan jalan awam

publicPath adalah penting untuk webpack untuk mencari ketulan yang dimuatkan secara dinamik. Ini boleh dikodkan, ditetapkan melalui pembolehubah persekitaran, atau diluluskan pada masa runtime. Untuk contoh ini, kami akan lulus:

 $ blockPublicPath = plugin_dir_url (__ file__). '/blok/Cache-Control/binaan/';
wp_localize_script (
  $ blockscriptregistrationName,
  'GraphqlapacacheControl',
  [
    // ...
    'PublicPath' => $ BlockPublicPath,
  ]
);

Kemudian tetapkannya di sebelah JavaScript:

 __webpack_public_path__ = window.graphqlapicachecontrol.publicpath;

Sandaran bahasa lalai

Mekanisme sandaran mengendalikan terjemahan yang hilang:

 const getmarkdowncontentorusedefault = (fileName, defaultLang, lang) => {
  Kembali getmarkdownContent (nama fail, lang)
    .catch (err => getMarkDownContent (FileName, DefaultLang));
};

Mengintegrasikan dengan modal

Akhirnya, kandungan markdown diintegrasikan ke dalam modal:

 import {usestate, useeffect} dari '@wordpress/element';
// ... import lain

const CacheControlContentModal = (props) => {
  // ...
  const [page, setPage] = useState ([]);

  useeffect (() => {
    getmarkdownContentorusedefault (FileName, DefaultLang, Lang) .then (nilai => {
      setPage (nilai);
    });
  }, []);

  kembali (
    <contentmodal content="{page}"></contentmodal>
  );
};

Pendekatan ini menyediakan sistem dokumentasi yang mantap, dikekalkan, dan setempat dalam editor WordPress.

Atas ialah kandungan terperinci Menggunakan Markdown dan Penyetempatan di Editor Blok WordPress. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!