No description
- PHP 66.1%
- JavaScript 19.3%
- SCSS 5.1%
- CSS 4%
- TypeScript 3%
- Other 2.5%
| assets-example | ||
| data | ||
| lib | ||
| .gitignore | ||
| .htaccess | ||
| autoload.php | ||
| composer.json | ||
| index.php | ||
| Readme.md | ||
| tsconfig.json | ||
slimDoc
Your Documentation software for Markdown
Usage
- Clone this Repository
- Install Dependencies with composer:
composer install - Generate the javascript with
tsc - copy
data/config.example.initodata/config.iniand edit to fit your needs.invalidateCacheAfteris in seconds. - Place your markdown files in
data/pagelike 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