Download de PineDocs - Download do código -fonte PineDocs

PineDocs

Dados do site

1.2.5

Baixar

Pinedocs

Um site rápido e leve para visualizar arquivos.

Ótimo para documentação, wiki, exemplos, notas, documentos, galerias, armazenamento, etc.

Docker Hub | Capturas de tela | Configuração | Configuração | Patrocinador

Veja mais capturas de tela em https://imgur.com/a/15gq67x

Patrocinador

Por favor, considere patrocinar ou doar para manter este projeto ativo - https://github.com/sponsors/xy2z

Características

Nenhum banco de dados.
Sem edifício.
Rápido - usando Ajax e cache.
Suporta o Markdown, PlainText, HTML, Code, Images, SVG, GIFs, Mathjax, PDFs, Audio e vídeos pequenos. Basicamente, tudo o que você pode renderizar em um navegador.
Layouts responsivos e diferentes esquemas de cores (veja capturas de tela aqui)
Sintaxe Destaque para mais de 169 idiomas com mais de 77 temas.
Configuração (veja abaixo).
Filtragem rápida em arquivos.
Use seus arquivos existentes ou repositórios Git existentes como conteúdo.
Os arquivos são em cache do lado do cliente após a primeira exibição, por isso carrega instantaneamente.
Pastas ocultas - acessíveis apenas por links diretos.
Lembra -se da posição de rolagem por página.

Site somente leitura

O Pinedocs é somente leitura, o que significa que você só pode visualizar arquivos e não editá-los via Pinedocs. Esta não é uma substituição do wiki no login de usuários, revisões etc. Este é basicamente um site simples que renderiza tudo no seu diretor de conteúdo. Portanto, você precisa editar os arquivos no seu servidor/PC para alterar o conteúdo.

Configurar

Docker

Docker é a maneira mais fácil de configurar os Pinedocs.

Docker-compose.yml

 version : ' 3 '

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

Depois de executar docker-compose up -d você pode alterar a configuração ./data/config/config.yaml e adicionar seus arquivos (ou clone seu repositório) no ./data/files dir.

As alterações afetarão quando você recarregar a página - não é necessário reiniciar o contêiner.

Docker

Ao contrário do Docker-Compose é recomendado, você também pode usar o Pure Docker:

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

Veja mais em https://hub.docker.com/r/xy2z/pinedocs/

Configuração manual

Requisitos

Php 8.0 (a versão PHP necessária para Mininum é PHP 7.2.5)
Compositor para dependências.
Um servidor da web (Apache2, Nginx, etc.)

Guia de configuração

Faça o download do último lançamento ou Run git clone
Execute composer install na raiz para obter dependências.
Configure o servidor da web com o PineDocs/public Dir (use php -S localhost:89 -t public for Testing)
(Opcional) Renomeie o arquivo config/config-example.yaml para config/config.yaml para alterar as configurações (veja abaixo)
(Opcional) Renomeie o arquivo config/mathjax-example.js para config/mathjax.js para alterar as configurações do Mathjax (veja abaixo)
(Opcional) Altere o arquivo config/custom.js ao usar o Docker para personalizar o JavaScript
(Opcional) Altere o arquivo config/custom.css ao usar o Docker para personalizar CSS

Configuração

Sinta -se à vontade para editar o arquivo config/config.yaml para atender às suas necessidades.

Você pode configurar o Mathjax editando o arquivo config/mathjax.js .

Configurações

title (String) O título do site, usado no logotipo, guias e favoritos.
content_dir (string) caminho para o diretor que você deseja usar. O padrão é o Pinedocs/ Content/ Dir.
index (String) Caminho relativo para o arquivo de índice. O padrão é a matriz de index.md , index.html , index.txt , index .
layout (string) Layouts disponíveis: default , wiki .
color_scheme (string) Esquemas de cores disponíveis: pinedocs , simplistic , simplistic-dark , twilight .
highlight_theme (string) O tema a ser usado para o código. Veja uma lista em https://highlightjs.org/static/demo/
code_transparent_bg (bool) Se true , tudo usará o tema de destaque. Se false , o fundo será transparente.
open_dirs (int | string) o número de níveis de dirs que devem ser opnados na carga da página. Use all para abrir todos os diretores.
render_footer (bool) renderizar o rodapé do menu?
Lista exclude_files (Array) de arquivos ou diretores para excluir. Suporta regex se o formato for /regex /i.
show_file_extension (BOOL) Mostrar extensões de arquivo. O padrão é verdadeiro.
menu_link_format (String) Valores: Padrão, UCFirst, UCWORDS, Uppercase, minúsculas.
render_max_file_size (float) Tamanho do arquivo máximo (em MB) para renderizar. Se o arquivo for maior, um link de download será mostrado. O padrão é 50 .
font_family (string) A fonte usada para menu e conteúdo. O padrão é Tahoma .
font_size (String) O tamanho da fonte no menu e no conteúdo. O padrão é 15px .
no_extension_markdown (BOOL) Renderize arquivos sem extensão como marcação, por exemplo, README . Padrão true .
break_code_blocks (BOOL) Blocos de código de interrupção em várias linhas em vez de rolar horizontalmente. Padrão false .
hide_folders_in_navigation (matriz) Uma lista de pastas para ocultar a navegação front -end. Isensível ao caso. Padrão não é.
enable_mathjax (BOOL) Ativar Mathjax. Deve estar ativado para mathjax.js funcionar. O padrão é false .