PineDocs Download - PineDocs Quellcode Download

PineDocs

Website-Daten

1.2.5

Herunterladen

Pinedocs

Eine schnelle und leichte Site zum Anzeigen von Dateien.

Ideal für Dokumentation, Wiki, Beispiele, Notizen, Dokumente, Galerien, Speicher usw.

Docker Hub | Screenshots | Setup | Konfiguration | Sponsor

Weitere Screenshots finden Sie unter https://imgur.com/a/15gq67x

Sponsor

Bitte erwägen Sie das Sponsern oder Spenden, um dieses Projekt aktiv zu halten - https://github.com/sponsors/xy2z

Merkmale

Keine Datenbank.
Kein Gebäude.
Schnell - mit Ajax und Cache.
Unterstützt Markdown, Plaintext, HTML, Code, Bilder, SVG, GIFs, Mathjax, PDFs, Audio und kleine Videos. Grundsätzlich können Sie alles in einem Browser rendern.
Responsive Layouts und verschiedene Farbschemata (siehe Screenshots hier)
Syntax -Hervorhebung für über 169 Sprachen mit über 77 Themen.
Konfiguration (siehe unten).
Schnelle Filterung in Dateien.
Verwenden Sie Ihre vorhandenen Dateien oder vorhandenen GIT -Repos als Inhalt.
Die Dateien werden nach der ersten Ansicht zwischengespeichert, sodass sie sofort geladen werden.
Versteckte Ordner - Nur über direkte Links zugänglich.
Erinnert sich die Bildlaufposition pro Seite.

Schreibgeschützte Seite

Pinedocs ist schreibgeschützt, dh Sie können nur Dateien anzeigen und nicht über Pindeocs bearbeiten. Dies ist kein Wiki -Ersatz durch Benutzeranmeldung, Revisionen usw. Dies ist im Grunde eine einfache Website, die alles in Ihrem Inhaltsdurchdring macht. Sie müssen also die Dateien auf Ihrem Server/PC bearbeiten, um den Inhalt zu ändern.

Aufstellen

Docker

Docker ist der einfachste Weg, um Pindeocs einzurichten.

Docker-compose.yml

 version : ' 3 '

services :
  web :
    image : xy2z/pinedocs:1.2.5
    ports :
      - 3000:80
    volumes :
      - ./data:/data/pinedocs

Nach dem Ausführen docker-compose up -d können Sie die Konfiguration in ./data/config/config.yaml ändern und Ihre Dateien (oder das Git -Klon Ihr Repository) in der Dir ./data/files hinzufügen.

Änderungen haben sich beim Nachladen der Seite aus. Der Container muss nicht neu gestartet werden.

Docker

Altough Docker-Compose wird empfohlen. Sie können auch Pure Docker verwenden:

docker run -itd -v "$PWD"/data:/data/pinedocs -p 3000:80 xy2z/pinedocs

Weitere Informationen finden Sie unter https://hub.docker.com/r/xy2z/pinedocs/

Handbuch Setup

Anforderungen

PHP 8.0 (MININUM ERFORDERLICHE PHP -Version ist PHP 7.2.5)
Komponist für Abhängigkeiten.
Ein Webserver (Apache2, Nginx usw.)

Setup -Handbuch

Laden Sie den neuesten Veröffentlichung herunter oder führen Sie git clone aus
Führen Sie composer install um Abhängigkeiten zu erhalten.
Richten Sie den Webserver auf das PineDocs/public DIR ein (verwenden Sie php -S localhost:89 -t public zum Testen)
(Optional) Benennen Sie die Datei config/config-example.yaml in config/config.yaml zum Ändern der Einstellungen (siehe unten)
(Optional) Benennen Sie die Dateikonfiguration config/mathjax-example.js in config/mathjax.js zum Ändern der Einstellungen von Mathjax (siehe unten).
(Optional) Ändern Sie die Dateikonfiguration config/custom.js wenn Sie Docker verwenden, um JavaScript anzupassen
(Optional) Ändern Sie die Dateikonfiguration config/custom.css wenn Sie Docker zum Anpassen von CSS verwenden

Konfiguration

Fühlen Sie sich frei, die Datei config/config.yaml so zu bearbeiten, dass sie Ihren Anforderungen entsprechen.

Sie können Mathjax konfigurieren, indem Sie die Datei config/mathjax.js bearbeiten.

Einstellungen

title (Zeichenfolge) Der Titel der Website, verwendet in Logo, Registerkarten und Lesezeichen.
content_dir (String) Pfad zum Dir, den Sie verwenden möchten. Standard ist die Pindeocs/ Inhalt/ Dir.
index (Zeichenfolge) relativer Pfad zur Indexdatei. Standard ist ein Array von index.md , index.html , index.txt , index .
layout (Zeichenfolge) verfügbare Layouts: default , wiki .
color_scheme (String) verfügbare Farbschemata: pinedocs , simplistic , simplistic-dark , twilight .
highlight_theme (Zeichenfolge) Das Thema für Code. Siehe eine Liste unter https://highlightjs.org/static/demo/
code_transparent_bg (bool) Wenn true , werden alle das Highlight -Thema verwenden. Wenn false , ist der Hintergrund transparent.
open_dirs (int | String) Die Anzahl der Stufen von Diren, die auf der Seite geladen werden sollten. Verwenden Sie all , um alle Dires zu öffnen.
render_footer (bool) die Menüfußzeile rendern?
exclude_files (Array) Liste von Dateien oder Diren, die ausgeschlossen werden sollen. Unterstützt Regex, wenn das Format /regex /i ist.
show_file_extension (bool) show Dateierweiterungen. Standard ist wahr.
menu_link_format (String) Werte: Standard, UCFirst, UCWords, Großbuchstaben, Kleinbuchstaben.
render_max_file_size (float) Max -Dateigröße (in MB) zum Rendern. Wenn die Datei größer ist, wird ein Download -Link angezeigt. Standard ist 50 .
font_family (Zeichenfolge) Die Schriftart für Menü und Inhalt. Standard ist Tahoma .
font_size (Zeichenfolge) Die Schriftgröße in Menü und Inhalt. Standard ist 15px .
no_extension_markdown (BOOL) Renderdateien ohne Erweiterung als Markdown, z. B. README . Standard true .
break_code_blocks (bool) break codes blocks in mehreren zeilen anstatt horizontal scrollen. Standard false .
hide_folders_in_navigation (array) Eine Liste von Ordnern, die sich vor Frontend Navigation ausblenden können. Fall-unempfindlich. Standard ist keine.
enable_mathjax (bool) aktivieren mathjax. Muss für mathjax.js aktiviert werden. Standard ist false .