-
-
Notifications
You must be signed in to change notification settings - Fork 271
/
Copy pathlarecipe.php
137 lines (123 loc) · 4.1 KB
/
larecipe.php
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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
<?php
return [
/*
|--------------------------------------------------------------------------
| Documentation Routes
|--------------------------------------------------------------------------
|
| These options configure the behavior of the LaRecipe docs basic route
| where you can specify the url of your documentations, the location
| of your docs and the landing page when a user visits /docs route.
|
|
*/
'docs' => [
'route' => '/docs',
'path' => '/resources/docs',
'landing' => 'overview',
],
/*
|--------------------------------------------------------------------------
| Documentation Versions
|--------------------------------------------------------------------------
|
| Here you may specify and set the versions and the default (latest) one
| of your documentation's versions where you can redirect the user to.
| Just make sure that the default version is in the published list.
|
|
*/
'versions' => [
'default' => '1.0',
'published' => [
'1.0'
]
],
/*
|--------------------------------------------------------------------------
| Documentation Settings
|--------------------------------------------------------------------------
|
| These options configure the additional behaviors of your documentation
| where you can limit the access to only authenticated users in your
| system. It is false initially so that guests can view your docs.
|
|
*/
'settings' => [
'auth' => false,
'ga_id' => ''
],
/*
|--------------------------------------------------------------------------
| Cache
|--------------------------------------------------------------------------
|
| Obviously rendering markdown at the back-end is costly especially if
| the rendered files are massive. Thankfully, caching is considered
| as a good option to speed up your app when having high traffic.
|
| Caching period unit: minutes
|
*/
'cache' => [
'enabled' => false,
'period' => 5
],
/*
|--------------------------------------------------------------------------
| Documentation Repository
|--------------------------------------------------------------------------
|
| This is an optional config you can set in order to show an external link
| to your documentation's repository if you have one. Once you set the
| value of the url, LaRecipe automatically will show the nav button.
|
|
*/
'repository' => [
'provider' => 'github',
'url' => 'https://github.com/saleem-hadad/larecipe'
],
/*
|--------------------------------------------------------------------------
| Appearance
|--------------------------------------------------------------------------
|
| Here you can add configure the appearance of your docs. For example,
| you can swap the default logo to custom one that matches your Id
| Also, you can change the theme of your docs if you prefer that
|
| Supported Themes: 'light', 'dark'
|
*/
'ui' => [
'show_app_name' => true,
'logo' => '', // e.g.: /images/logo.svg
'fav' => '', // e.g.: /fav.png
'theme' => 'light',
'back_to_top' => true,
'additional_css' => [
//'css/custom.css',
],
'additional_js' => [
//'js/custom.js',
],
],
/*
|--------------------------------------------------------------------------
| SEO
|--------------------------------------------------------------------------
|
| These options configure the SEO settings of your docs. You can set the
| author, the description and the keywords. Also, LaRecipe by default
| sets the canonical link to the viewed page's link automatically.
|
|
*/
'seo' => [
'author' => '',
'description' => '',
'keywords' => ''
]
];