PineDocs Download - PineDocs Code source Télécharger

PineDocs

Données du site Web

1.2.5

Télécharger

Pinedocs

Un site rapide et léger pour afficher les fichiers.

Idéal pour la documentation, le wiki, les exemples, les notes, les documents, les galeries, le stockage, etc.

Docker Hub | Captures d'écran | Configuration | Configuration | Parrainer

Voir plus de captures d'écran à https://imgur.com/a/15gq67x

Parrainer

Veuillez envisager de parrainer ou de faire un don pour maintenir ce projet actif - https://github.com/sponsors/xy2z

Caractéristiques

Pas de base de données.
Aucun bâtiment.
Rapide - en utilisant ajax et cache.
Prend en charge Markdown, PlainText, HTML, Code, Images, SVG, GIFS, Mathjax, PDFS, Audio et petites vidéos. Fondamentalement, tout ce que vous pouvez rendre dans un navigateur.
Dispositions réactives et différents schémas de couleurs (voir des captures d'écran ici)
Syntaxe mettant en évidence pour plus de 169 langues avec plus de 77 thèmes.
Configuration (voir ci-dessous).
Filtrage rapide dans les fichiers.
Utilisez vos fichiers existants ou les repos GIT existants comme contenu.
Les fichiers sont cachés côté client après la première vue, il se charge donc instantanément.
Dossiers cachés - uniquement accessibles via des liens directs.
Se souvient de la position de défilement par page.

Site en lecture seule

Pinedocs est en lecture seule, ce qui signifie que vous ne pouvez afficher que des fichiers et ne pas les modifier via Pinedocs. Ce n'est pas un remplaçant wiki par la connexion des utilisateurs, les révisions, etc. Il s'agit essentiellement d'un site simple qui rend tout dans votre contenu. Vous devez donc modifier les fichiers de votre serveur / PC afin de modifier le contenu.

Installation

Docker

Docker est le moyen le plus simple de configurer les Pinedocs.

Docker-compose.yml

 version : ' 3 '

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

Après avoir exécuté docker-compose up -d vous pouvez modifier la configuration dans ./data/config/config.yaml , et ajouter vos fichiers (ou git clone votre référentiel) dans le ./data/files dir.

Les modifications prendront un effet lorsque vous rechargez la page - pas besoin de redémarrer le conteneur.

Docker

Altough Docker-Compose est recommandé, vous pouvez également utiliser Pure Docker:

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

Voir plus sur https://hub.docker.com/r/xy2z/pinedocs/

Configuration manuelle

Exigences

PHP 8.0 (la version PHP requise en minimum est PHP 7.2.5)
Compositeur pour les dépendances.
Un serveur Web (apache2, nginx, etc.)

Guide de configuration

Téléchargez la dernière version ou exécutez git clone
Exécutez composer install dans la racine pour obtenir des dépendances.
Configurer le serveur Web au PineDocs/public Dir (Utilisez php -S localhost:89 -t public pour les tests)
(Facultatif) Renommer le fichier config/config-example.yaml à config/config.yaml pour modifier les paramètres (voir ci-dessous)
(Facultatif) Renommer le fichier config/mathjax-example.js à config/mathjax.js pour modifier les paramètres de MathJax (voir ci-dessous)
(Facultatif) Modifiez le fichier config/custom.js lors de l'utilisation de Docker pour personnaliser JavaScript
(Facultatif) Modifiez le fichier config/custom.css lors de l'utilisation de Docker pour personnaliser CSS

Configuration

N'hésitez pas à modifier le fichier config/config.yaml pour répondre à vos besoins.

Vous pouvez configurer Mathjax en modifiant le fichier config/mathjax.js .

Paramètres

title (chaîne) Le titre du site, utilisé dans le logo, les onglets et les signets.
chemin content_dir (String) vers le Dir que vous souhaitez utiliser. La valeur par défaut est le Pinedocs / Content / Dir.
index (chaîne) Chemin relatif vers le fichier d'index. La valeur par défaut est le tableau d' index.md , index.html , index.txt , index .
layout (chaîne) Disposés disponibles: default , wiki .
color_scheme (String) Schémas de couleurs disponibles: pinedocs , simplistic , simplistic-dark , twilight .
highlight_theme (String) Le thème à utiliser pour le code. Voir une liste sur https://highlightjs.org/static/demo/
code_transparent_bg (bool) Si true , tous utiliseront le thème de surbrillance. Si false , l'arrière-plan sera transparent.
open_dirs (int | string) Le nombre de niveaux de DIRS qui doivent être opinés sur le chargement de la page. Utilisez all pour ouvrir tous les réseaux.
render_footer (bool) Rendre le pied de page du menu?
exclude_files (array) Liste de fichiers ou de réseaux à exclure. Prend en charge Regex si le format est / regex / i.
show_file_extension (bool) Afficher les extensions de fichiers. La valeur par défaut est vraie.
menu_link_format (String) Valeurs: par défaut, UCFirst, UCWords, majuscules, minuscules.
render_max_file_size (float) Taille de fichier maximale (en MB) pour rendre. Si le fichier est plus grand, un lien de téléchargement sera affiché. La valeur par défaut est 50 .
font_family (String) La police utilisée pour le menu et le contenu. Le défaut est Tahoma .
font_size (String) La taille de la police dans le menu et le contenu. La valeur par défaut est 15px .
no_extension_markdown (BOOL) Rendez les fichiers sans extension comme Markdown, par exemple README . Par défaut true .
break_code_blocks (bool) Break Code Blocks en plusieurs lignes au lieu de faire défiler horizontalement. Par défaut false .
hide_folders_in_navigation (tableau) Une liste de dossiers à masquer à la navigation frontale. Insensible à la cas. La valeur par défaut n'est pas.
enable_mathjax (bool) Activer Mathjax. Doit être activé pour que mathjax.js fonctionne. La valeur par défaut est false .