PineDocs下載 - PineDocs源代碼下載

PineDocs

網站數據

1.2.5

下載

Pinedocs

一個快速輕巧的網站，用於查看文件。

非常適合文檔，Wiki，示例，筆記，文檔，畫廊，存儲等。

Docker Hub |屏幕截圖|設置|配置|贊助

請參閱https://imgur.com/a/15gq67x的更多屏幕截圖

贊助

請考慮贊助或捐贈以保持該項目活躍-https：//github.com/sponsors/xy2z

特徵

沒有數據庫。
沒有建築物。
快速 - 使用AJAX和緩存。
支持Markdown，“明文”，HTML，代碼，圖像，SVG，GIF，Mathjax，PDFS，Audio和小視頻。基本上，您可以在瀏覽器中渲染的任何內容。
響應迅速的佈局和不同的配色方案（請參閱此處的屏幕截圖）
語法突出顯示了超過77個主題的169多種語言。
配置（見下文）。
快速過濾文件。
使用您現有的文件或現有的git存儲庫作為內容。
第一次視圖之後，文件是緩存的客戶端，因此立即加載。
隱藏文件夾 - 僅通過直接鏈接訪問。
記住每頁滾動位置。

僅閱讀網站

Pinedocs是只讀的，這意味著您只能查看文件而不能通過Pinedocs進行編輯。這不是用戶登錄，修訂等的Wiki替換。這基本上是一個簡單的網站，可以在您的內容中呈現所有內容。因此，您需要在服務器/PC上編輯文件以更改內容。

設定

Docker

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 dir中添加文件（或git git clone is repository）。

重新加載頁面時，更改會影響 - 無需重新啟動容器。

Docker

建議使用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 Reired PHP版本為PHP 7.2.5）
依賴關係的作曲家。
Web服務器（Apache2，nginx等）

設置指南

下載最新版本或運行git clone
在根中composer install以獲取依賴項。
將Web服務器設置為PineDocs/public Dir（使用php -S localhost:89 -t public進行測試）
（可選）將文件config/config-example.yaml重命名為config/config.yaml以進行更改的設置（請參見下文）
（可選）將文件config/mathjax-example.js重命名為config/mathjax.js ，用於更改MathJax的設置（請參見下文）
（可選）使用Docker自定義JavaScript時更改文件config/custom.js
（可選）使用Docker自定義CSS時更改文件config/custom.css

配置

請隨時編輯config/config.yaml文件以滿足您的需求。

您可以通過編輯config/mathjax.js文件來配置MathJax。

設定

title （字符串）網站的標題，用於徽標，選項卡和書籤。
content_dir （string）您要使用的DIR的路徑。默認值是Pinedocs/ content/ dir。
index （字符串）索引文件的相對路徑。默認值是index.md ， index.html ， index.txt ， index的數組。
layout （字符串）可用佈局： default ， wiki 。
color_scheme （字符串）可用配色方案： pinedocs ， simplistic ， simplistic-dark ， twilight 。
highlight_theme （字符串）用於代碼的主題。請參閱https://highlightjs.org/static/demo/的列表
code_transparent_bg （bool）如果為true ，所有這些都將使用突出顯示主題。如果是false ，則背景將是透明的。
open_dirs （int | string）應在頁面加載上打開的DIR級別數量。使用all打開所有迪爾。
render_footer （bool）渲染菜單頁腳？
exclude_files （array）文件或dir列表以排除。如果格式為 /regex /i，則支持正則義務。
show_file_extension （bool）顯示文件擴展。默認是正確的。
menu_link_format （字符串）值：默認，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）在多行中打破代碼塊，而不是水平滾動。默認false 。
hide_folders_in_navigation （數組）一個文件夾列表，要隱藏在前端導航中。案例不敏感。默認值無。
enable_mathjax （bool）啟用Mathjax。必須啟用mathjax.js工作。默認值為false 。