Cara membina laman web dokumentasi menggunakan PHP dan Docusaurus-tutorial php-php.cn

Cara membina laman web dokumentasi menggunakan PHP dan Docusaurus

王林

Lepaskan： 2023-06-19 20:32:01

asal

1244 orang telah melayarinya

Dalam era digital, dengan inovasi berterusan pelbagai sistem perniagaan, aplikasi, dll., pengguna bukan sahaja memerlukan manual terhad kepada fungsi pengendalian, tetapi juga tapak web dokumentasi yang komprehensif untuk membimbing dan menyokong keperluan perniagaan mereka. Sebagai tindak balas kepada keperluan ini, artikel ini akan berkongsi cara menggunakan PHP dan Docusaurus untuk membina tapak web dokumentasi yang komprehensif.

1. Docusaurus

Docusaurus ialah alat sumber terbuka yang diselenggara dan dibangunkan oleh komuniti Facebook. Berdasarkan alat React dan Markdown, ia boleh digunakan untuk membantu syarikat B2B dan pelbagai syarikat WEB dengan cepat membina tapak web dokumen, dan juga boleh digunakan untuk membina tapak peribadi.

Docusaurus menyediakan Markdown terbina dalam dan enjin carian terbina dalam, tema dan pemalam yang boleh disesuaikan, dan juga ciri yang boleh disesuaikan melalui beribu-ribu pakej React dan NPM. Lebih penting lagi, ia menjadikan tapak web dokumentasi anda sangat boleh diselenggara dan berskala.

2. PHP

PHP ialah bahasa skrip bahagian pelayan yang sangat popular, digunakan secara meluas dalam bidang pembangunan web Ia mudah untuk dimulakan, mempunyai kos pembangunan yang rendah, menyokong yang besar bilangan pangkalan data, dan popular di kalangan pemaju. Fail Docusaurus yang dijana boleh dijana secara dinamik melalui PHP atau bahasa sebelah pelayan lain, jadi artikel ini akan menumpukan pada cara menggunakan PHP sebagai perisian tengah untuk membina tapak web dokumentasi muktamad.

3. Cara menggunakan PHP dan Docusaurus untuk membina tapak web dokumentasi

1. Pasang Docusaurus

Pertama, anda perlu memasang Docusaurus secara setempat dan masukkan direktori projek.

2 Mulakan dokumen

Dalam Docusaurus, dokumen ditulis dalam Markdown dan setiap dokumen mempunyai tajuk peringkat teratas. Jalankan arahan berikut untuk menjana Hello.md di bawah /example-site/docs/:

cd /example-site/
npx @docusaurus/init init my-website classic
cd my-website

Salin selepas log masuk

3 Cipta fail PHP

dan kemudian buat fail index.php baharu di bawah tapak contoh. /. Kandungannya adalah seperti berikut:

<?php
$page = $_GET['page'];
if (file_exists('build/'.$page.'.html')) {
    // 如果文件存在，则返回文件内容
    echo file_get_contents('build/'.$page.'.html');
} else {
    // 否则，返回默认内容
    echo file_get_contents('default.html');
}
?>

Salin selepas log masuk

4 Cipta fail default.html

Buat fail default.html baharu di bawah tapak contoh dengan kandungan berikut:

<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Document</title>
</head>
<body>
<h1>Hello World!</h1>
</body>
</html>

Salin selepas log masuk

<. 🎜>Kod di atas digunakan Teks lalai dikembalikan apabila ralat 404 dipaparkan Jika halaman yang dilawati tidak dijana, Hello World dikembalikan secara lalai.

4. Mulakan pelayan PHP

Pergi ke direktori tapak contoh, mulakan pelayan PHP, dan jalankan arahan berikut:

php -S localhost:8000 index.php

Salin selepas log masuk

5 🎜>

Selepas menggunakan Docusaurus untuk menjana dokumen, salin fail yang dijana dalam direktori binaan/statik/ ke tapak contoh/bangunan/.

6. Lengkap

Pada ketika ini, dokumen telah berjaya dijana dan digunakan melalui pelayan PHP. Anda boleh memasukkan http://localhost:8000/?page=Hello dalam penyemak imbas untuk melihat fail Hello.md yang baru anda tulis.

4 Ringkasan

Menggunakan Docusaurus dan PHP untuk membina tapak web dokumentasi adalah sangat mudah untuk dikendalikan, menjadikan tapak web dokumentasi anda berada dalam talian dengan cepat, yang boleh membantu pengguna anda menyelesaikan masalah dengan cepat dan meningkatkan pengguna mereka. pengalaman. Saya harap dengan berkongsi artikel ini, anda boleh cuba membina laman web dokumentasi yang ringan dan mudah digunakan, tetapi masih boleh skala.

Atas ialah kandungan terperinci Cara membina laman web dokumentasi menggunakan PHP dan Docusaurus. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!