


Menggunakan Markdown dan Penyetempatan di Editor Blok WordPress
Apr 02, 2025 am 04:27 AMPerlu 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:
- Menggunakan markdown untuk dokumentasi dalam blok editor WordPress.
- 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!

Alat AI Hot

Undress AI Tool
Gambar buka pakaian secara percuma

Undresser.AI Undress
Apl berkuasa AI untuk mencipta foto bogel yang realistik

AI Clothes Remover
Alat AI dalam talian untuk mengeluarkan pakaian daripada foto.

Clothoff.io
Penyingkiran pakaian AI

Video Face Swap
Tukar muka dalam mana-mana video dengan mudah menggunakan alat tukar muka AI percuma kami!

Artikel Panas

Alat panas

Notepad++7.3.1
Editor kod yang mudah digunakan dan percuma

SublimeText3 versi Cina
Versi Cina, sangat mudah digunakan

Hantar Studio 13.0.1
Persekitaran pembangunan bersepadu PHP yang berkuasa

Dreamweaver CS6
Alat pembangunan web visual

SublimeText3 versi Mac
Perisian penyuntingan kod peringkat Tuhan (SublimeText3)

Topik panas

CSS Blok halaman yang diberikan kerana pelayar melihat CSS dalam talian dan luaran sebagai sumber utama secara lalai, terutamanya dengan stylesheet yang diimport, header sejumlah besar CSS sebaris, dan gaya pertanyaan media yang tidak dapat dioptimumkan. 1. Ekstrak CSS kritikal dan membenamkannya ke HTML; 2. Kelewatan memuatkan CSS bukan kritikal melalui JavaScript; 3. Gunakan atribut media untuk mengoptimumkan pemuatan seperti gaya cetak; 4. Memampatkan dan menggabungkan CSS untuk mengurangkan permintaan. Adalah disyorkan untuk menggunakan alat untuk mengekstrak CSS utama, menggabungkan REL = "Preload" pemuatan asynchronous, dan menggunakan media yang ditangguhkan dengan munasabah untuk mengelakkan pemisahan yang berlebihan dan kawalan skrip kompleks.

AutoPrefixer adalah alat yang secara automatik menambah awalan vendor ke atribut CSS berdasarkan skop penyemak imbas sasaran. 1. Ia menyelesaikan masalah mengekalkan awalan secara manual dengan kesilapan; 2. Bekerja melalui borang pemalam postcss, menghuraikan CSS, menganalisis atribut yang perlu diawali, dan menjana kod mengikut konfigurasi; 3. Langkah-langkah penggunaan termasuk memasang pemalam, menetapkan senarai pelayar, dan membolehkan mereka dalam proses membina; 4. Nota termasuk tidak menambah awalan secara manual, menyimpan kemas kini konfigurasi, awalan tidak semua atribut, dan disyorkan untuk menggunakannya dengan preprocessor.

Function-gradient () functionIncsscreatesculculargradientsthatrotatecolorstopsaroundroentroint.1.ISIISIDEALFORPIECHARTS, Progressindicators, Colorwheels, andDecorativeBackgrounds.2.itworksByDefiningColorStopsatSpecificles, OpsticalStarting

TOCREATESTICKYHEADERSANDFOOTERSWITHCSS, USEPOSISI: STICKYFORHEADERSWITHOPVARUEANDZ-INDEX, MemastikanParentContainersdon'Trestrictit.1.ForstickyHeaders: SetPosition: Sticky, atas: 0, Z-index, dan BEBERKOORSICHISTORS.2.FORTOORSTICE: FORBORTORSIS.2.FORTORSICHORORS.

Skop sifat adat CSS bergantung kepada konteks perisytiharan mereka, pembolehubah global biasanya ditakrifkan dalam: akar, manakala pembolehubah tempatan ditakrifkan dalam pemilih khusus untuk komponen dan pengasingan gaya. Sebagai contoh, pembolehubah yang ditakrifkan dalam kelas .card hanya tersedia untuk unsur -unsur yang sepadan dengan kelas dan anak -anak mereka. Amalan terbaik termasuk: 1. Penggunaan: Root untuk menentukan pembolehubah global seperti warna topik; 2. Tentukan pembolehubah tempatan di dalam komponen untuk melaksanakan enkapsulasi; 3. Elakkan berulang kali mengisytiharkan pemboleh ubah yang sama; 4. Beri perhatian kepada masalah liputan yang mungkin disebabkan oleh kekhususan pemilih. Di samping itu, pembolehubah CSS adalah sensitif kes dan harus ditakrifkan sebelum digunakan untuk mengelakkan kesilapan. Jika pemboleh ubah tidak ditentukan atau rujukan gagal, nilai sandaran atau nilai awal lalai akan digunakan. Debug boleh dilakukan melalui pemaju penyemak imbas

Mudah alih-firstcssdesignrequiressettingtheViewportmetatag, menggunakan pelindung, stylingfromsmallscreensup, optimizingtypographyandtouchtargets.first, addtocontrolscaling.second, use%, eM, orreminsteadofpixelflexflexflexflexflexflexflexflexflexflexflexflexflexflexflexflexflexflexflexflexflexflexflexflexflexflexflexflexflexflexflexflexflexflex

Untuk membuat susun atur grid responsif intrinsik, kaedah teras adalah menggunakan mod berulang CSSGRID (auto-fit, minmax ()); 1. Tetapkan grid-templat-lajur: ulangi (auto-fit, Minmax (200px, 1FR)) untuk membiarkan penyemak imbas secara automatik menyesuaikan bilangan lajur dan menghadkan lebar minimum dan maksimum setiap lajur; 2. Gunakan jurang untuk mengawal jarak grid; 3. Bekas hendaklah ditetapkan kepada unit relatif seperti lebar: 100%, dan gunakan kotak saiz: kotak sempadan untuk mengelakkan kesilapan pengiraan lebar dan memusatkannya dengan margin: auto; 4. Secara pilihan menetapkan ketinggian baris dan penjajaran kandungan untuk meningkatkan konsistensi visual, seperti baris

Terdapat tiga cara untuk membuat pemutar pemuatan CSS: 1. Gunakan pemutar asas sempadan untuk mencapai animasi mudah melalui HTML dan CSS; 2. Gunakan pemutar tersuai pelbagai mata untuk mencapai kesan lompat melalui masa kelewatan yang berlainan; 3. Tambahkan pemutar dalam butang dan beralih kelas melalui JavaScript untuk memaparkan status pemuatan. Setiap pendekatan menekankan pentingnya butiran reka bentuk seperti warna, saiz, kebolehcapaian dan pengoptimuman prestasi untuk meningkatkan pengalaman pengguna.
