PHP と Docusaurus を使用してドキュメント Web サイトを構築する方法-PHPチュートリアル-php.cn

PHP と Docusaurus を使用してドキュメント Web サイトを構築する方法

王林

リリース： 2023-06-19 20:32:01

オリジナル

1285 人が閲覧しました

デジタル時代においては、さまざまなビジネスシステムやアプリケーションが継続的に革新されており、ユーザーは操作機能に限定されたマニュアルだけでなく、ビジネスをガイドしサポートするための包括的なドキュメント Web サイトも必要としています。このニーズに応えて、この記事では PHP と Docusaurus を使用して包括的なドキュメント Web サイトを構築する方法を紹介します。

1. Docusaurus

Docusaurus は、Facebook コミュニティによって維持および開発されているオープンソースツールであり、静的サイト生成ツールです。 React および Markdown ツールをベースとしており、B2B 企業やさまざまな WEB 企業がドキュメント Web サイトを迅速に構築するのに使用できるほか、個人サイトの構築にも使用できます。

Docusaurus は、組み込みの Markdown と組み込みの検索エンジン、カスタマイズ可能なテーマとプラグイン、さらには数千の React および NPM パッケージを通じてカスタマイズ可能な機能を提供します。さらに重要なことは、ドキュメント Web サイトの保守性と拡張性が非常に高くなるということです。

2. PHP

PHP は非常に人気のあるサーバーサイドスクリプト言語であり、Web 開発の分野で広く使用されています。簡単に始めることができ、開発コストが低く、大規模な機能をサポートしています。データベースの数が多く、開発者の間で人気があり、読者からも愛されています。 Docusaurus の生成されたファイルは、PHP またはその他のサーバーサイド言語を通じて動的に生成できるため、この記事では PHP をミドルウェアとして使用して究極のドキュメント Web サイトを構築する方法に焦点を当てます。

3. PHP と Docusaurus を使用してドキュメント Web サイトを構築する方法

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 ファイルが表示されます。

4. 概要

Docusaurus と PHP を使用してドキュメント Web サイトを構築するのは操作が非常に簡単で、ドキュメント Web サイトがすぐにオンラインになり、ユーザーが問題を迅速に解決し、ユーザーの質を向上させるのに役立ちます。経験。この記事を共有することで、軽量で使いやすく、しかもスケーラブルなドキュメント Web サイトの構築に挑戦していただければ幸いです。

以上がPHP と Docusaurus を使用してドキュメント Web サイトを構築する方法の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。