PineDocs

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克隆您的存储库）。

重新加载页面时，更改会影响 - 无需重新启动容器。

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等）

设置指南

1. 下载最新版本或运行git clone
2. 在根中composer install以获取依赖项。
3. 将Web服务器设置为PineDocs/public Dir（使用php -S localhost:89 -t public进行测试）
4. （可选）将文件config/config-example.yaml重命名为config/config.yaml以进行更改的设置（请参见下文）
5. （可选）将文件config/mathjax-example.js重命名为config/mathjax.js ，用于更改MathJax的设置（请参见下文）
6. （可选）使用Docker自定义JavaScript时更改文件config/custom.js
7. （可选）使用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 。

执照

GNU GPLV3。请参阅LICENDE.TXT