No description
This repository has been archived on 2026-11-17. You can view files and clone it, but you cannot make any changes to its state, such as pushing and creating new issues, pull requests or comments.
  • PHP 66.1%
  • JavaScript 19.3%
  • SCSS 5.1%
  • CSS 4%
  • TypeScript 3%
  • Other 2.5%
Find a file
2021-02-17 08:54:54 +01:00
assets-example add example assets folder 2021-02-15 09:31:22 +01:00
data added note to file upload to page 2021-02-17 08:54:54 +01:00
lib set max upload size in config 2021-02-16 14:47:12 +01:00
.gitignore fix file permissions 2021-02-15 15:52:22 +01:00
.htaccess fix file permissions 2021-02-15 15:52:22 +01:00
autoload.php fix file permissions 2021-02-15 15:52:22 +01:00
composer.json fix file permissions 2021-02-15 15:52:22 +01:00
index.php delete files from recycle, when time is over 2021-02-16 11:11:47 +01:00
Readme.md fix file permissions 2021-02-15 15:52:22 +01:00
tsconfig.json fix file permissions 2021-02-15 15:52:22 +01:00

slimDoc

Your Documentation software for Markdown

Usage

  1. Clone this Repository
  2. Install Dependencies with composer: composer install
  3. Generate the javascript with tsc
  4. copy data/config.example.ini to data/config.ini and edit to fit your needs. invalidateCacheAfter is in seconds.
  5. Place your markdown files in data/page like the example files

Notes

  • The router will generate a cache folder in data/cache to store files after building. If you change some files, you should delete this folder.
  • Files & Folder without a number and a "_" in front of the name will be ignored in the menu
  • The image size array in the config has the following format: screenSize:imageWidth:imageHeight(optional),screenSize:imageSize:imageHeight(optional)
  • For the image sizes, please start with the biggest number and end with the smallest

Required PHP extensions

  • php-xml