PineDocs
- 0 ratings
Simple, fast, customizable and lightweight site for browsing files.
Deploy this app to Linode with a free $100 credit!
See more screenshots at https://imgur.com/a/15Gq67X
💚 Please consider sponsoring or donating to keep this project active - https://github.com/sponsors/xy2z
PineDocs is read-only, meaning you can only view files and not edit them via PineDocs. This is not a wiki replacement with user login, revisions etc. This is basically a simple site that renders everything in your content dir. So you need to edit the files on your server/PC in order to change the content.
Docker is the easiest way to setup PineDocs.
version: '3'
services:
web:
image: xy2z/pinedocs:1.2.5
ports:
- 3000:80
volumes:
- ./data:/data/pinedocsAfter running docker-compose up -d you can change the config in ./data/config/config.yaml, and add your files (or git clone your repository) in the ./data/files dir.
Changes will take affect when you reload the page - no need to restart the container.
Altough docker-compose is recommended, you can also use pure Docker:
docker run -itd -v "$PWD"/data:/data/pinedocs -p 3000:80 xy2z/pinedocs
See more at https://hub.docker.com/r/xy2z/pinedocs/
git clonecomposer install in the root to get dependencies.PineDocs/public dir (use php -S localhost:89 -t public for testing)config/config-example.yaml to config/config.yaml for changing settings (see below)config/mathjax-example.js to config/mathjax.js for changing settings of Mathjax (see below)config/custom.js when using Docker to customize Javascriptconfig/custom.css when using Docker to customize CSSFeel free to edit the config/config.yaml file to fit your needs.
You can configure Mathjax by editing the config/mathjax.js file.
title (string) The title of the site, used in logo, tabs and bookmarks.
content_dir (string) Path to the dir you want to use. Default is the PineDocs/content/ dir.
index (string) Relative path to the index file. Default is array of index.md, index.html, index.txt, index.
layout (string) Available layouts: default, wiki.
color_scheme (string) Available color schemes: pinedocs, simplistic, simplistic-dark, twilight.
highlight_theme (string) The theme to use for code. See a list at https://highlightjs.org/static/demo/
code_transparent_bg (bool) If true, all will use the highlight theme. If false, the background will be transparent.
open_dirs (int|string) The number of levels of dirs that should be opnened on page load. Use all to open all dirs.
render_footer (bool) Render the menu footer?
exclude_files (array) List of files or dirs to exclude. Supports regex if the format is /regex/i.
show_file_extension (bool) Show file extensions. Default is true.
menu_link_format (string) Values: default, ucfirst, ucwords, uppercase, lowercase.
render_max_file_size (float) Max file size (in MB) to render. If file is larger, a download link will be shown. Default is 50.
font_family (string) The font used for menu and content. Default is Tahoma.
font_size (string) The font size in menu and content. Default is 15px.
no_extension_markdown (bool) Render files with no extension as markdown, eg README. Default true.
break_code_blocks (bool) Break code blocks in multiple lines instead of horizontally scrolling. Default false.
hide_folders_in_navigation (array) A list of folders to hide from frontend navigation. Case-insensitive. Default is none.
enable_mathjax (bool) Enable MathJax. Must be enabled for mathjax.js to work. Default is false.
GNU GPLv3. See LICENSE.txt
Please login to review this project.
No reviews for this project yet.
Comments (0)
Please login to join the discussion on this project.