Скачать PineDocs - скачать исходный код PineDocs

PineDocs

Данные веб-сайта

1.2.5

Скачать

Pinedocs

Быстрый и легкий сайт для просмотра файлов.

Отлично подходит для документации, вики, примеров, примечаний, документов, галерей, хранения и т. Д.

Docker Hub | Скриншоты | Настройка | Конфигурация | Спонсор

Смотрите больше скриншотов по адресу https://imgur.com/a/15gq67x

Спонсор

Пожалуйста, рассмотрите возможность спонсоров или пожертвования, чтобы сохранить этот проект активным - https://github.com/sponsors/xy2z

Функции

Нет базы данных.
Нет здания.
Быстро - используя Ajax и Cache.
Поддерживает Markdown, Plaintext, HTML, код, изображения, SVG, GIFS, MathJax, PDFS, аудио и небольшие видео. В основном все, что вы можете сделать в браузере.
Отзывчивые макеты и разные цветовые схемы (см. Скриншоты здесь)
Синтаксис выделяет более 169 языков с более чем 77 темами.
Конфигурация (см. Ниже).
Быстрая фильтрация в файлах.
Используйте существующие файлы или существующие репозиции GIT в качестве контента.
Файлы кэшируются на стороне клиента после первого представления, поэтому он загружается мгновенно.
Скрытые папки - доступны только через прямые ссылки.
Помнит позицию прокрутки на страницу.

Сайт только для чтения

Pinedocs только для чтения, то есть вы можете просматривать файлы и не редактировать их через Pinedocs. Это не вики -замена с помощью входа в систему пользователя, пересмотров и т. Д. Это в основном простой сайт, который отдает все в вашем контенте. Таким образом, вам нужно отредактировать файлы на вашем сервере/ПК, чтобы изменить контент.

Настраивать

Докер

Docker - самый простой способ настроить Pinedocs.

Docker-Compose.yml

 version : ' 3 '

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

После запуска docker-compose up -d вы можете изменить конфигурацию в ./data/config/config.yaml и добавить свои файлы (или клонировать свой репозиторий) в ./data/files

Изменения будут влиять, когда вы перезагружаете страницу - нет необходимости перезагрузить контейнер.

Докер

Рекомендуется Altough Docker-Compose, вы также можете использовать Pure Docker:

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

Смотрите больше на https://hub.docker.com/r/xy2z/pinedocs/

Ручная установка

Требования

PHP 8.0 (Mininum требуется PHP версия PHP 7.2.5)
Композитор для зависимостей.
Веб -сервер (Apache2, Nginx и т. Д.)

Руководство по настройке

Загрузите последний релиз или запустите git clone
Запустите composer install в корне, чтобы получить зависимости.
Настройка веб -сервера на PineDocs/public Dir (используйте php -S localhost:89 -t public для тестирования)
(Необязательно) Переименовать файл config/config-example.yaml в config/config.yaml для изменения настроек (см. Ниже)
(Необязательно) Переименовать файл config/mathjax-example.js в config/mathjax.js для изменения настройки MathJax (см. Ниже)
(Необязательно) Измените файл config/custom.js при использовании Docker для настройки JavaScript
(Необязательно) Измените файл config/custom.css при использовании Docker для настройки CSS

Конфигурация

Не стесняйтесь редактировать файл config/config.yaml чтобы соответствовать вашим потребностям.

Вы можете настроить MathJax, редактируя файл config/mathjax.js .

Настройки

title (строка) Название сайта, используемое в логотипе, вкладках и закладках.
content_dir (строка) путь к указанию, который вы хотите использовать. По умолчанию Pinedocs/ Content/ Dir.
index (строка) относительный путь к индексному файлу. По умолчанию - массив index.md , index.html , index.txt , index .
layout (String) Доступные макеты: default , wiki .
color_scheme (String) Доступные цветовые схемы: pinedocs , simplistic , simplistic-dark , twilight .
highlight_theme (String) Тема для использования для кода. Смотрите список по адресу https://highlightjs.org/static/demo/
code_transparent_bg (bool) Если true , все будут использовать тему выделения. Если false , фон будет прозрачным.
open_dirs (int | String) Количество уровней DIR, которые должны быть выпущены на загрузке страницы. Используйте all , чтобы открыть все Dirs.
render_footer (bool) визуализируйте нижний колонтитул меню?
exclude_files (массив) Список файлов или дираций, чтобы исключить. Поддерживает regex, если формат составляет /regex /i.
show_file_extension (bool) Показать расширения файла. По умолчанию верно.
menu_link_format (String) значения: по умолчанию, UCFirst, UCWords, верхний регистр, нижний регистр.
render_max_file_size (float) размер максимального размера (в MB) для рендеринга. Если файл больше, будет показана ссылка загрузки. По умолчанию 50 .
font_family (строка) шрифт, используемый для меню и контента. По умолчанию Tahoma .
font_size (строка) размер шрифта в меню и содержании. По умолчанию 15px .
рендеринговые файлы no_extension_markdown (bool) без расширения в качестве разметки, например, README . По умолчанию true .
break_code_blocks (bool) Break Blocks Blocks в нескольких строках вместо горизонтальной прокрутки. По умолчанию false .
hide_folders_in_navigation (массив) Список папок, чтобы спрятаться от навигации Frontend. Случай нечувствителен. По умолчанию нет.
enable_mathjax (BOOL) ENABLE MATHJAX. Должен быть включен для mathjax.js для работы. По умолчанию false .