Code d'implémentation de l'outil de gestion de documents PHP Markdown

Cet article partage principalement avec vous le code d'implémentation de l'outil de gestion de documents PHP markdown, dans l'espoir d'aider tout le monde.

Objectifs principaux :

1. Peut être modifié par plusieurs personnes

2 Peut être visualisé dans un navigateur

3. contents

4. Prend en charge les répertoires multi-niveaux

5. Prend en charge le markdown

6. Rapide et pratique

Je suis engagé dans le développement PHP depuis mon enfance. travail précédent. Bao Dalaan a été relégué à l'écriture d'interfaces côté serveur. Il est entré en contact avec plusieurs outils ou systèmes de gestion de documents d'interface. Voici une brève description :

1. showdoc, qui est complet et concis. Utilisateur, fonction de gestion des droits, prend en charge le démarque, prend en charge l'exportation de mots, dispose d'une variété de modèles de documents, le répertoire prend en charge le pliage à deux niveaux

2. confluence, fonctions puissantes ( gestion des droits, rappels par email, recherche en texte intégral, gestion des plug-ins, etc.), système de gestion de documents lourd et payant

3. swagger, qui nécessite écrire beaucoup de commentaires dans le code pour coopérer

4. readmine, riche en fonctions similaires à confluence, ses documents sont enregistrés en txt, les modifications peuvent être tracées et la recherche en texte intégral est disponible , mais écrire des documents est un peu pénible, adapté à la gestion du suivi des tâches/bugs, etc.

5. Gitbook, installation de nodejs, prend en charge le markdown, prend en charge les plug-ins npm. la gauche doit installer des plug-ins, et vous pouvez également installer des plug-ins de recherche. Les répertoires sont des fichiers de démarques séparés. Lorsque je les utilise, j'ai l'impression que la compilation de md à HTML est trop lente (plus de 600 documents, cela prend plus de temps). plus de 25 minutes pour compiler. S'il existe des plug-ins pour une compilation incrémentielle ou pour améliorer la vitesse de compilation, veuillez m'éclairer

Solution :

1. . Cela peut être réalisé en combinant avec git, et vous pouvez également utiliser la fonction de gestion des autorisations de git

2. Vous devez compiler le markdown dans un fichier HTML et le déployer sur l'intranet

3. Parce que je souhaite le visualiser dans un navigateur, j'ai finalement choisi dtree.js avec un accès simple, une interface propre et sans dépendances (ne repose pas sur jQuery)

4. Cette fonction utilise l'algorithme de parcours d'ordre post-racine de l'arborescence pour réaliser la lecture de fichiers multi-niveaux (la récursion n'est pas utilisée et j'ai peur d'avoir des ennuis lors de l'écriture). prend également en charge le pliage de répertoires multi-niveaux

5. Ici, j'ai finalement choisi la classe d'outil de compilation PHP officiellement produite par segmentfault (car ils ont déjà référencé et optimisé de nombreuses classes PHP similaires, merci~)

6. Rapide Si vous souhaitez compiler plus de 600 fichiers, PHP prend environ 2 secondes, ce qui est acceptable, et il prend en charge la compilation incrémentielle si cela est pratique, cela se reflète principalement dans le fait ; que le répertoire est généré automatiquement, et qu'il n'est pas nécessaire d'écrire le répertoire séparément

Problèmes rencontrés :

Compilation incrémentale

Au premier démarrage pour juger si un fichier md doit être compilé en HTML, on compare l'heure de création et l'heure de dernière modification du fichier md,
Mais plus tard j'ai découvert que cette méthode ne fonctionnait pas pour certains fichiers copiés et renommés <.>Enfin, un fichier intermédiaire a été utilisé pour enregistrer l'heure du fichier compilé, puis suivi de max( Comparer l'heure de création, l'heure de la dernière modification) pour déterminer si une compilation est nécessaire

Supprimer les fichiers redondants

Lors de l'utilisation ultérieure, il a été constaté que certains documents md ont été supprimés, mais les fichiers compilés finaux n'ont pas été automatiquement supprimés

Par conséquent, lors de la compilation, une différence sera faite entre le fichier md et le fichier HTML final. , et ces fichiers HTML redondants seront supprimés.

Intégrez dtree.js

Tout d'abord, dtree.js. Une certaine quantité de données json est requise pour afficher le répertoire et interagir avec l'expansion et la réduction <.> De plus, la police de dtree.js est relativement petite et ses images, styles et fichiers de script sont tous des chemins relatifs. J'ai modifié les chemins en conséquence, remplacez-le par un chemin absolu basé sur le nom de domaine actuel. que lors du déploiement sur différents noms de domaine, il n'est pas nécessaire de modifier l'assemblage du répertoire hiérarchique

du code dtree.js, et l'assemblage HTML d'embellissement

est écrit à l'avance Préparez les codes HTML pour la tête, le bas, la barre latérale, etc. du HTML, puis insérez ces contenus dans le contenu compilé, et enfin placez-les dans les dossiers correspondants pour l'embellissement

Cela est principalement dû à la sortie officielle de segmentfault L'outil de compilation. n'ajoute pas de styles aux éléments HTML (par exemple, tableau, code). J'ai trouvé les styles CSS pertinents sur github ici et je les ai embellis

Prise en charge des répertoires multi-niveaux

Cela m'a également coûté un beaucoup Il a été écrit avec beaucoup de cellules cérébrales. Quand j'écrivais du codage Huffman dynamique à l'université, j'ai écrit une traversée d'arbres

Je pensais que je le connaissais, mais je ne savais pas que cela prenait jusqu'à 3 heures. 'horloge la nuit pour enfin l'écrire. Cette fonction est également considérée comme le noyau. C'est l'un des composants.

Recommandations associées :

Vuejs utilise vue-markdown pour afficher les méthodes de commentaire

Aperçu du démarque et modifier le style d'aperçu dans VSCode

Une brève introduction à l'éditeur de démarques

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!