Implementierungscode des PHP-Markdown-Dokumentenverwaltungstools

Dieser Artikel teilt Ihnen hauptsächlich den Implementierungscode des PHP-Markdown-Dokumentenverwaltungstools mit und hofft, allen zu helfen.

Hauptziele:

Kann von mehreren Personen bearbeitet werden

Kann in einem Browser angezeigt werden

3 Inhalte

Unterstützt mehrstufige Verzeichnisse

Unterstützt Markdown

6. Ich beschäftige mich seit meiner Kindheit mit der PHP-Entwicklung vorheriger Job. Bao Dalaan wurde auf das Schreiben von Schnittstellen auf der Serverseite verwiesen. Er kam mit mehreren Schnittstellen-Dokumentenverwaltungstools oder -systemen in Kontakt. Hier ist eine kurze Beschreibung:

showdoc. Das ist umfassend und prägnant. Benutzer, Rechteverwaltungsfunktion, unterstützt Markdown, unterstützt Word-Export, verfügt über eine Vielzahl von Dokumentvorlagen, das Verzeichnis unterstützt zweistufige Faltung
Konfluenz, leistungsstarke Funktionen ( Rechteverwaltung, E-Mail-Erinnerungen, Volltextsuche, Plug-in-Verwaltung usw.), umfangreiches, kostenpflichtiges Dokumentenverwaltungssystem

2. Prahlerei, das erfordert Schreiben Sie viele Kommentare in den Code, um zusammenzuarbeiten

3. readmine, reich an Funktionen ähnlich wie Confluence, seine Dokumente werden im TXT-Format gespeichert, Änderungen können nachverfolgt werden und eine Volltextsuche ist verfügbar , aber das Schreiben von Dokumenten ist etwas mühsam, geeignet für die Aufgaben-/Fehlerverfolgungsverwaltung usw.

4. Gitbook, NodeJS-Installation, unterstützt Markdown, unterstützt npm-Plug-Ins. Der faltbare Verzeichnisbaum ist aktiviert Auf der linken Seite müssen Plug-Ins installiert werden, und Sie können auch Such-Plug-Ins installieren. Wenn ich sie verwende, ist die Kompilierung von MD zu HTML zu langsam (mehr als 600 Dokumente). Wenn es Plug-Ins für die inkrementelle Kompilierung oder die Verbesserung der Kompilierungsgeschwindigkeit gibt, klären Sie mich bitte auf

5. Lösung:

Dies kann durch Kombination mit Git erreicht werden, und Sie können auch die Berechtigungsverwaltungsfunktion von Git verwenden

1. Sie müssen Markdown in eine HTML-Datei kompilieren und im Intranet bereitstellen

2. Da ich es in einem Browser anzeigen möchte, habe ich mich schließlich für dtree.js mit einfachem Zugriff, sauberer Oberfläche und ohne Abhängigkeiten entschieden (basiert nicht auf jQuery)

3. Diese Funktion verwendet den Post-Root-Order-Traversal-Algorithmus des Baums, um das Lesen von mehrstufigen Dateien zu realisieren (Rekursion wird nicht verwendet, und ich befürchte, dass ich beim Schreiben Probleme bekomme). Unterstützt auch die mehrstufige Verzeichnisfaltung

4. Hier habe ich mich schließlich für die PHP-Kompilierungstoolklasse entschieden, die offiziell von segmentfault produziert wurde (da sie bereits viele ähnliche PHP-Klassen referenziert und optimiert haben, danke ~)

5. Schnell Wenn Sie mehr als 600 Dateien kompilieren möchten, dauert PHP etwa 2 Sekunden, was akzeptabel ist, und es unterstützt die inkrementelle Kompilierung, wenn dies praktisch ist dass das Verzeichnis automatisch generiert wird und es nicht erforderlich ist, das Verzeichnis separat zu schreiben

6. Aufgetretene Probleme:

Inkrementelle Kompilierung

Beim ersten Start Um zu beurteilen, ob eine MD-Datei in HTML kompiliert werden muss, vergleichen wir die Erstellungszeit und die letzte Änderungszeit der MD-Datei.

Aber später stellte ich fest, dass diese Methode bei einigen kopierten und umbenannten Dateien nicht funktionierte 🎜>Schließlich wurde eine Zwischendatei verwendet, um die Zeit der kompilierten Datei aufzuzeichnen, gefolgt von max( Erstellungszeit vergleichen, letzte Änderungszeit vergleichen), um festzustellen, ob eine Kompilierung erforderlich ist

Redundante Dateien löschen

Bei der späteren Verwendung wurde festgestellt, dass einige MD-Dokumente gelöscht wurden, die endgültigen kompilierten Dateien jedoch nicht automatisch gelöscht wurden.

Daher wird beim Kompilieren ein Differenzsatz zwischen der MD-Datei und der endgültigen HTML-Datei erstellt , und diese überflüssigen HTML-Dateien werden gelöscht

Dtree.js integrieren

Zuerst ist eine bestimmte Menge an JSON-Daten erforderlich, um das Verzeichnis anzuzeigen und mit Erweitern und Reduzieren zu interagieren 🎜> Außerdem ist die Schriftart von dtree.js relativ klein und alle Bilder, Stile und Skriptdateien sind relative Pfade. Ich habe sie daher in einen absoluten Pfad geändert, der auf dem aktuellen Domänennamen basiert dass bei der Bereitstellung auf verschiedenen Domänennamen die hierarchische Verzeichnis-

-Assembly des dtree.js-Codes nicht geändert werden muss und die verschönernde HTML-

-Assembly im Voraus geschrieben wird. Bereiten Sie die HTML-Codes vor für den Kopf, die Unterseite, die Seitenleiste usw., fügen Sie diese Inhalte dann in den kompilierten Inhalt ein und legen Sie sie schließlich zur
Verschönerung ab. Dies ist hauptsächlich auf die offizielle Veröffentlichung von segmentfault zurückzuführen fügt keine Stile zu HTML-Elementen hinzu (z. B. Tabelle, Code). Ich habe die relevanten CSS-Stile von Github hier gefunden und verschönert.

Unterstützt mehrstufige Verzeichnisse

Das hat mich auch gekostet viel Es wurde mit vielen Gehirnzellen geschrieben, als ich im College eine Baumdurchquerung schrieb.
Ich dachte, ich wäre damit vertraut, aber ich wusste nicht, dass es bis 3 Uhr dauerte 'Nachts, um es endlich zu schreiben, wird diese Funktion auch als eine der Kernkomponenten angesehen.

Verwandte Empfehlungen:

Vuejs verwendet Vue-Markdown, um Kommentarmethoden zu rendern

Markdown in der Vorschau anzeigen und den Vorschaustil in VSCode ändern

Eine kurze Einführung in den Markdown-Editor

Das obige ist der detaillierte Inhalt vonImplementierungscode des PHP-Markdown-Dokumentenverwaltungstools. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!