Comment créer un site Web de documentation en utilisant PHP et Docusaurus-tutoriel php-php.cn

Comment créer un site Web de documentation en utilisant PHP et Docusaurus

王林

Libérer： 2023-06-19 20:32:01

original

1284 Les gens l'ont consulté

À l'ère numérique, avec l'innovation continue de divers systèmes d'entreprise, applications, etc., les utilisateurs ont besoin non seulement de manuels limités aux fonctions d'exploitation, mais également d'un site Web de documentation complet pour guider et soutenir leurs besoins commerciaux. En réponse à ce besoin, cet article expliquera comment utiliser PHP et Docusaurus pour créer un site Web de documentation complet.

1. Docusaurus

Docusaurus est un outil open source maintenu et développé par la communauté Facebook. C'est un outil de génération de sites statiques. Basé sur les outils React et Markdown, il peut être utilisé pour aider les entreprises B2B et diverses sociétés WEB à créer rapidement des sites Web de documents, et peut également être utilisé pour créer des sites personnels.

Docusaurus fournit un Markdown et un moteur de recherche intégrés, des thèmes et des plugins personnalisables, et même des fonctionnalités personnalisables via des milliers de packages React et NPM. Plus important encore, cela rend votre site Web de documentation hautement maintenable et évolutif.

2. PHP

PHP est un langage de script côté serveur très populaire, largement utilisé dans le domaine du développement Web. Il est facile à démarrer, a un faible coût de développement, prend en charge un grand nombre de bases de données et est profondément apprécié. par les développeurs. Les fichiers générés par Docusaurus peuvent être générés dynamiquement via PHP ou d'autres langages côté serveur. Cet article se concentrera donc sur la façon d'utiliser PHP comme middleware pour créer le site Web de documentation ultime.

3. Comment utiliser PHP et Docusaurus pour créer un site Web de documentation

1 Installer Docusaurus

Tout d'abord, vous devez installer Docusaurus localement et entrer dans le répertoire du projet.

2. Initialiser les documents

Dans Docusaurus, les documents sont écrits en Markdown et chaque document a un titre de niveau supérieur. Exécutez la commande suivante pour générer Hello.md sous /example-site/docs/:

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

Copier après la connexion

3 Créez un fichier PHP

Créez ensuite un nouveau fichier index.php sous example-site/ avec le contenu suivant :

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

Copier après la connexion

. 4 .Créez un fichier default.html

Créez un nouveau fichier default.html sous exemple-site avec le contenu suivant :

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

Copier après la connexion

Le code ci-dessus est le texte par défaut renvoyé lors de l'affichage d'une erreur 404 si la page visitée n'est pas générée. , Bonjour sera renvoyé par défaut Monde.

4. Démarrez le serveur PHP

Allez dans le répertoire du site d'exemple, démarrez le serveur PHP et exécutez la commande suivante :

php -S localhost:8000 index.php

Copier après la connexion

5. Générez le document

Après avoir utilisé Docusaurus pour générer le document, la build générée. /static/ répertoire Copiez simplement le fichier dans example-site/build/.

6. Terminé

À ce stade, le document a été généré et déployé avec succès via le serveur PHP. Vous pouvez saisir http://localhost:8000/?page=Hello dans le navigateur pour afficher le fichier Hello.md que vous venez d'écrire.

4. Résumé

L'utilisation de Docusaurus et de PHP pour créer un site Web de documentation est très simple à utiliser, ce qui permet à votre site Web de documentation d'être mis en ligne rapidement, ce qui peut aider vos utilisateurs à résoudre rapidement les problèmes et à améliorer leur expérience utilisateur. J'espère qu'en partageant cet article, vous pourrez essayer de créer un site Web de documentation léger, facile à utiliser, mais toujours évolutif.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!