如何使用PHP和Docusaurus建立文件網站
- 王林原創
- 2023-06-19 20:31:431245瀏覽
在數位化時代，隨著各類業務系統、應用程式等的不斷推陳出新，使用者需要的也不僅僅是僅限於操作功能的使用手冊，而更需要一個全面的文檔網站來指引和支援其業務需求。針對這個需求，本文將分享如何使用PHP和Docusaurus建立一個全面的文件網站。
一、Docusaurus
Docusaurus是由Facebook社群維護和開發的開源工具，它是一個靜態網站產生工具。基於React和Markdown工具，它可以用來幫助B2B公司及各類WEB企業快速建立文件網站，也可以用於個人網站的建置。
Docusaurus提供了內建的Markdown和內建的搜尋引擎，可自訂主題和插件，甚至可以透過成千上萬的React和NPM包自訂功能。更重要的是，它可以讓您的文件網站具備良好的可維護性和可擴充性。
二、PHP
PHP是一種非常流行的伺服器端腳本語言，廣泛應用於Web開發領域，它易於上手，開發成本低，支援大量資料庫，而且深受開發者的喜愛。 Docusaurus的生成檔案可以透過PHP或其他伺服器端語言動態生成，那麼本篇文章將著重講述如何使用PHP作為中間件，建立極致的文檔網站。
三、如何使用PHP和Docusaurus建立文件網站
1.安裝Docusaurus
首先需要在本地安裝好Docusaurus，並進入到專案目錄。
2.初始化文件
在Docusaurus中，文件是由Markdown編寫，每個文件都有一個頂層的大標題。執行以下命令，可在/example-site/docs/下產生Hello.md:
cd /example-site/ npx @docusaurus/init init my-website classic cd my-website
3.建立PHP檔案
然後在example-site/下方新建index.php文件，其內容如下：
<?php
$page = $_GET['page'];
if (file_exists('build/'.$page.'.html')) {
// 如果文件存在，则返回文件内容
echo file_get_contents('build/'.$page.'.html');
} else {
// 否则，返回默认内容
echo file_get_contents('default.html');
}
?>4.建立default.html文件
在example-site下新建default.html文件，內容如下：
<!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <title>Document</title> </head> <body> <h1>Hello World!</h1> </body> </html>
以上程式碼是用於顯示404錯誤時返回的預設文本，如果訪問的頁面沒有生成，則預設返回Hello World。
4.啟動PHP伺服器
進入到example-site目錄下，啟動PHP伺服器，執行下列指令:
php -S localhost:8000 index.php
5.產生文件
#使用Docusaurus產生文件後，將產生的build/static/目錄下的檔案複製到example-site/build/下即可。
6.完成
至此，文件已經成功產生並透過PHP伺服器進行了部署。您可以在瀏覽器中輸入http://localhost:8000/?page=Hello 來檢視您剛才所寫的Hello.md檔。
四、總結
使用Docusaurus和PHP建立文件網站非常易於操作，使得您的文件網站快速上線，進而可以幫助您的用戶快速解決問題，提高用戶的使用體驗。希望透過本篇文章的分享，您可以嘗試建立輕易上手，卻依然具有擴充性的文件網站。
以上是如何使用PHP和Docusaurus建立文件網站的詳細內容。更多資訊請關注PHP中文網其他相關文章！