-
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathconfig.php
More file actions
45 lines (42 loc) · 2.09 KB
/
config.php
File metadata and controls
45 lines (42 loc) · 2.09 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
<?php
/**
* This file is part of the phpMDocs.
* Copyright (c) Róbert Kelčák (https://kelcak.com/)
*/
declare(strict_types=1);
$is_https = (
(isset($_SERVER['HTTPS']) && ($_SERVER['HTTPS'] === 'on' || $_SERVER['HTTPS'] === 1)) ||
(isset($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] === 'https')
);
return [
'site_title' => 'phpMDocs', // Displayed on homepage and meta tag
'site_description' => '',
'site_path' => '/', // If a script is running in subdir, need to set the current directory name, e.g. /docs/ for site.com/docs
'site_url' => 'http'.($is_https ? 's' : '').'://'.$_SERVER['SERVER_NAME'], // If that doesn't work, it may be replaced with the actual URL
'site_url_sitemap' => 'https://example.com', // For sitemap generator
'keywords' => ['docs', 'php', 'markdown'],
'docs_path' => __DIR__.'/docs', // Path to dir with documentation
'ignore_files' => [
// List of ignored files and dirs in docs dir. If empty, these files will appear in the search results
'.gitattributes', '.gitignore', 'LICENSE', 'README.md',
],
'logo' => 'LOGO', // or '<img src="'.(new RobiNN\Pmd\Documentation())->path('assets/img/logo.svg').'" alt="{site_title}">'
'nav_links' => [
['link' => '{site_url}', 'title' => 'Home'],
//['link' => '/page', 'title' => 'Page Title'],
],
'category_page' => false, // Set true to show category with all pages in that category
'reorder_items' => [
// e.g. ['page', 'category', 'page2'] - items will be displayed in this order,
// pages that are not listed will not be displayed (homepage only), if is empty nothing will change.
'home' => [],
],
'twig_debug' => false,
'cache' => [
'enabled' => true,
'expiration' => 3600, // 1h default
// Available config options - https://github.com/RobiNN1/Cache#usage
'storage' => 'file',
'file' => ['path' => __DIR__.'/cache/data', 'secret' => 'phpmdocs_cache'],
],
];