Descargar PineDocs - Descargar el código fuente PineDocs

PineDocs

Datos del sitio web

1.2.5

Descargar

Pindocs

Un sitio rápido y liviano para ver archivos.

Excelente para documentación, wiki, ejemplos, notas, documentos, galerías, almacenamiento, etc.

Docker Hub | Capturas de pantalla | Configuración | Configuración | Patrocinador

Vea más capturas de pantalla en https://imgur.com/a/15gq67x

Patrocinador

Considere patrocinar o donar para mantener este proyecto activo - https://github.com/sponsors/xy2z

Características

No hay base de datos.
Sin edificio.
Rápido: usando Ajax y caché.
Admite Markdown, texto sin formato, HTML, código, imágenes, SVG, GIFS, Mathjax, PDF, audio y videos pequeños. Básicamente, cualquier cosa que puedas renderizar en un navegador.
Diseños receptivos y diferentes esquemas de color (ver capturas de pantalla aquí)
Destacando sintaxis para más de 169 idiomas con más de 77 temas.
Configuración (ver más abajo).
Filtrado rápido en archivos.
Use sus archivos existentes o Repos existente como contenido.
Los archivos se almacenan en caché del lado del cliente después de la primera vista, por lo que se carga al instante.
Carpetas ocultas: solo accesible a través de enlaces directos.
Recuerda la posición de desplazamiento por página.

Sitio de solo lectura

Pinedocs es de solo lectura, lo que significa que solo puede ver los archivos y no editarlos a través de Pinedocs. Este no es un reemplazo de wiki con el inicio de sesión del usuario, las revisiones, etc. Este es básicamente un sitio simple que hace que todo en su directora de contenido. Por lo tanto, debe editar los archivos en su servidor/PC para cambiar el contenido.

Configuración

Estibador

Docker es la forma más fácil de configurar Pinedocs.

Docker-composa.yml

 version : ' 3 '

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

Después de ejecutar docker-compose up -d puede cambiar la configuración en ./data/config/config.yaml y agregar sus archivos (o clonar su repositorio) en el ./data/files dir.

Los cambios tendrán efecto cuando vuelva a cargar la página, no es necesario reiniciar el contenedor.

Estibador

Se recomienda todo Docker-Compose, también puede usar Pure Docker:

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

Ver más en https://hub.docker.com/r/xy2z/pinedocs/

Configuración manual

Requisitos

PHP 8.0 (la versión PHP requerida por Mininum es PHP 7.2.5)
Compositor para dependencias.
Un servidor web (apache2, nginx, etc.)

Guía de configuración

Descargue el último lanzamiento o ejecute git clone
Ejecute composer install en la raíz para obtener dependencias.
Configurar el servidor web en PineDocs/public Dir (use php -S localhost:89 -t public para pruebas)
(Opcional) Cambie el nombre del archivo config/config-example.yaml a config/config.yaml para cambiar la configuración (ver más abajo)
(Opcional) Cambie el nombre del archivo config/mathjax-example.js a config/mathjax.js para cambiar la configuración de MathJax (ver más abajo)
(Opcional) Cambie el archivo config/custom.js cuando use Docker para personalizar JavaScript
(Opcional) Cambie el archivo config/custom.css cuando use Docker para personalizar CSS

Configuración

No dude en editar el archivo config/config.yaml para que se ajuste a sus necesidades.

Puede configurar MathJax editando el archivo config/mathjax.js .

Ajustes

title (cadena) El título del sitio, utilizado en logotipo, pestañas y marcadores.
content_dir (string) ruta a la dirección que desea usar. El valor predeterminado es el Pinedocs/ Content/ Dir.
index (cadena) ruta relativa al archivo de índice. El valor predeterminado es la matriz de index.md , index.html , index.txt , index .
layout (cadena) Diseños disponibles: default , wiki .
color_scheme (String) Esquemas de color disponibles: pinedocs , simplistic , simplistic-dark , twilight .
highlight_theme (cadena) El tema a usar para el código. Vea una lista en https://highlightjs.org/static/demo/
code_transparent_bg (bool) Si es true , todos usará el tema destacado. Si es false , el fondo será transparente.
open_dirs (int | string) El número de niveles de DIR que deben opcarse en la carga de la página. Use all para abrir todos los directivos.
render_footer (bool) ¿Renderiza el pie de página del menú?
exclude_files (matriz) Lista de archivos o DIR para excluir. Admite regex si el formato es /regex /i.
show_file_extension (bool) Mostrar extensiones de archivo. El valor predeterminado es verdadero.
menu_link_format (string) Valores: predeterminado, ucfirst, ucwords, uppercase, minúscula.
render_max_file_size (float) tamaño de archivo máximo (en MB) para renderizar. Si el archivo es más grande, se mostrará un enlace de descarga. El valor predeterminado es 50 .
font_family (cadena) La fuente utilizada para el menú y el contenido. El valor predeterminado es Tahoma .
font_size (string) El tamaño de fuente en el menú y el contenido. El valor predeterminado es 15px .
no_extension_markdown (bool) Renderiza archivos sin extensión como markdown, por ejemplo, README . Predeterminado true .
break_code_blocks (BOOL) Bloques de código de ruptura en varias líneas en lugar de desplazamiento horizontal. false predeterminado.
hide_folders_in_navigation (Array) Una lista de carpetas para esconderse de la navegación frontend. Caso insensible. El valor predeterminado es ninguno.
enable_mathjax (bool) Enable MathJax. Debe estar habilitado para que mathjax.js funcione. El valor predeterminado es false .