Heim > Artikel > Backend-Entwicklung > So erstellen Sie eine Dokumentationswebsite mit PHP und Docusaurus

So erstellen Sie eine Dokumentationswebsite mit PHP und Docusaurus

王林Original: 2023-06-19 20:31:431282Durchsuche

Im digitalen Zeitalter, mit der kontinuierlichen Innovation verschiedener Geschäftssysteme, Anwendungen usw., benötigen Benutzer nicht nur Handbücher, die sich auf Betriebsfunktionen beschränken, sondern auch eine umfassende Dokumentationswebsite, um ihre Geschäftsanforderungen zu leiten und zu unterstützen. Als Reaktion auf diesen Bedarf erfahren Sie in diesem Artikel, wie Sie mit PHP und Docusaurus eine umfassende Dokumentationswebsite erstellen.

1. Docusaurus

Docusaurus ist ein Open-Source-Tool, das von der Facebook-Community gepflegt und entwickelt wird. Es handelt sich um ein statisches Site-Generierungstool. Basierend auf React- und Markdown-Tools kann es B2B-Unternehmen und verschiedenen WEB-Unternehmen dabei helfen, schnell Dokument-Websites zu erstellen, und kann auch zum Erstellen persönlicher Websites verwendet werden.

Docusaurus bietet integrierten Markdown und eine integrierte Suchmaschine, anpassbare Themes und Plugins und sogar anpassbare Funktionen über Tausende von React- und NPM-Paketen. Noch wichtiger ist, dass Ihre Dokumentationswebsite dadurch äußerst wartbar und skalierbar ist.

2. PHP

PHP ist eine sehr beliebte serverseitige Skriptsprache, die im Bereich der Webentwicklung weit verbreitet ist. Sie ist einfach zu starten, hat niedrige Entwicklungskosten, unterstützt eine große Anzahl von Datenbanken und ist sehr beliebt von Entwicklern. Die von Docusaurus generierten Dateien können dynamisch über PHP oder andere serverseitige Sprachen generiert werden. Daher konzentriert sich dieser Artikel auf die Verwendung von PHP als Middleware zum Erstellen der ultimativen Dokumentationswebsite.

3. So erstellen Sie mit PHP und Docusaurus eine Dokumentationswebsite

1. Installieren Sie Docusaurus zunächst lokal und geben Sie das Projektverzeichnis ein.

2. Dokumente initialisieren

In Docusaurus werden Dokumente in Markdown geschrieben und jedes Dokument hat einen Titel der obersten Ebene. Führen Sie den folgenden Befehl aus, um Hello.md unter /example-site/docs/ zu generieren:

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

3. Erstellen Sie eine PHP-Datei

und erstellen Sie dann eine neue index.php-Datei unter example-site/ mit dem folgenden Inhalt:

<?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 .Erstellen Sie eine Datei „default.html“.

Erstellen Sie unter „example-site“ eine neue Datei „default.html“ mit folgendem Inhalt:

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

Der obige Code ist der Standardtext, der zurückgegeben wird, wenn ein 404-Fehler angezeigt wird generiert, Hello wird standardmäßig World zurückgegeben.

4. Starten Sie den PHP-Server

Gehen Sie zum Beispiel-Site-Verzeichnis, starten Sie den PHP-Server und führen Sie den folgenden Befehl aus:

php -S localhost:8000 index.php

5. Nachdem Sie Docusaurus zum Generieren des Dokuments verwendet haben, wird der generierte Build erstellt /static/-Verzeichnis Kopieren Sie die Datei einfach nach example-site/build/.

6. Abgeschlossen

Zu diesem Zeitpunkt wurde das Dokument erfolgreich generiert und über den PHP-Server bereitgestellt. Sie können http://localhost:8000/?page=Hello in den Browser eingeben, um die gerade geschriebene Hello.md-Datei anzuzeigen.

4. Zusammenfassung

Die Verwendung von Docusaurus und PHP zum Erstellen einer Dokumentationswebsite ist sehr einfach zu bedienen, sodass Ihre Dokumentationswebsite schnell online geht, was Ihren Benutzern helfen kann, Probleme schnell zu lösen und ihre Benutzererfahrung zu verbessern. Ich hoffe, dass Sie durch das Teilen dieses Artikels versuchen können, eine Dokumentationswebsite zu erstellen, die leichtgewichtig, benutzerfreundlich und dennoch skalierbar ist.

Das obige ist der detaillierte Inhalt vonSo erstellen Sie eine Dokumentationswebsite mit PHP und Docusaurus. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!

php 中间件 html npm Static default 数据库 http 搜索引擎

Stellungnahme：

Der Inhalt dieses Artikels wird freiwillig von Internetnutzern beigesteuert und das Urheberrecht liegt beim ursprünglichen Autor. Diese Website übernimmt keine entsprechende rechtliche Verantwortung. Wenn Sie Inhalte finden, bei denen der Verdacht eines Plagiats oder einer Rechtsverletzung besteht, wenden Sie sich bitte an admin@php.cn

Vorheriger Artikel：Verwendung der Cache_Lite-Bibliothek in PHP zur Implementierung eines Caching-Mechanismus, der die Antwortgeschwindigkeit optimiertNächster Artikel：Verwendung der Cache_Lite-Bibliothek in PHP zur Implementierung eines Caching-Mechanismus, der die Antwortgeschwindigkeit optimiert

In Verbindung stehende Artikel

Mehr sehen