Skip to content

Commit d1445cc

Browse files
emmadesilvaemmadesilva
committed
Merge branch 'master' into 2.x-dev
2 parents a0bc7e2 + 331eb9c commit d1445cc

File tree

23 files changed

+1136
-24
lines changed

23 files changed

+1136
-24
lines changed

‎.github/workflows/continuous-integration.yml‎

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -304,14 +304,8 @@ jobs:
304304
- name: Install Composer Dependencies
305305
run: composer install --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
306306

307-
- name: Download configuration
308-
run: wget https://api.github.com/repos/hydephp/develop/zipball/gh-pages-config-dev-docs -O config.zip
309-
310-
- name: Unzip configuration
311-
run: unzip config.zip -d temp
312-
313-
- name: Copy configuration to root
314-
run: cp -r temp/hydephp-develop-*/* .
307+
- name: Copy configuration from configuration directory
308+
run: cp -r monorepo/gh-pages/gh-pages-config-dev-docs/* .
315309

316310
- name: Move documentation files
317311
run: rm -rf _docs && mv -f docs _docs
@@ -352,14 +346,8 @@ jobs:
352346
- name: Install Composer Dependencies
353347
run: composer install --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
354348

355-
- name: Download configuration
356-
run: wget https://api.github.com/repos/hydephp/develop/zipball/gh-pages-config -O config.zip
357-
358-
- name: Unzip configuration
359-
run: unzip config.zip -d temp
360-
361-
- name: Copy configuration to root
362-
run: cp -r temp/hydephp-develop-*/* .
349+
- name: Copy configuration from the configuration directory
350+
run: cp -r monorepo/gh-pages/gh-pages-config/* .
363351

364352
- name: Output the origin reference to file
365353
run: echo ${{ github.sha }} > origin-ref

‎.github/workflows/deploy-documentation-preview.yml‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,8 @@ jobs:
3333
- name: Install Composer Dependencies
3434
run: composer install --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
3535

36-
- name: Download configuration
37-
run: wget https://api.github.com/repos/hydephp/develop/zipball/gh-pages-config-dev-docs -O config.zip
38-
39-
- name: Unzip configuration
40-
run: unzip config.zip -d temp
41-
42-
- name: Copy configuration to root
43-
run: cp -r temp/hydephp-develop-*/* .
36+
- name: Copy configuration from the configuration directory
37+
run: cp -r monorepo/gh-pages/gh-pages-config-dev-docs/* .
4438

4539
- name: Update configuration files
4640
run: |

‎monorepo/gh-pages/gh-pages-config-dev-docs/README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Configuration template used to generate the upcoming documentation
2+
3+
- See https://hydephp.github.io/develop/master/preview/

‎monorepo/gh-pages/gh-pages-config-dev-docs/config/docs.php‎

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
<?php
2+
3+
/*
4+
|--------------------------------------------------------------------------
5+
| Documentation Module Settings
6+
|--------------------------------------------------------------------------
7+
|
8+
| Since the Hyde documentation module has many configuration options,
9+
| they have now been broken out into their own configuration file.
10+
|
11+
*/
12+
13+
return [
14+
/*
15+
|--------------------------------------------------------------------------
16+
| Sidebar Header Name
17+
|--------------------------------------------------------------------------
18+
|
19+
| By default, the sidebar title shown in the documentation page layouts uses
20+
| the app name suffixed with "docs". You can change it with this setting.
21+
|
22+
*/
23+
24+
'sidebar' => [
25+
// The title in the sidebar header
26+
'header' => env('SITE_NAME', 'HydePHP').' Docs',
27+
28+
// When using a grouped sidebar, should the groups be collapsible?
29+
'collapsible' => true,
30+
31+
// Should the sidebar footer be shown?
32+
'footer' => false,
33+
],
34+
35+
/*
36+
|--------------------------------------------------------------------------
37+
| Documentation Site Output Directory
38+
|--------------------------------------------------------------------------
39+
|
40+
| If you want to store the compiled documentation pages in a different
41+
| directory than the default 'docs' directory, for example to set the
42+
| specified version, you can specify the directory here.
43+
|
44+
| Note that you need to take care as to not set it to something that
45+
| may conflict with other parts, such as media or posts directories.
46+
|
47+
| The default value is 'docs'. For easy versioning you can do what
48+
| HydePHP.com does, setting it to 'docs/master'.
49+
|
50+
*/
51+
52+
'output_directory' => 'dev-docs',
53+
54+
/*
55+
|--------------------------------------------------------------------------
56+
| Collaborative Source Editing Location
57+
|--------------------------------------------------------------------------
58+
|
59+
| @see https://hydephp.com/docs/master/documentation-pages#automatic-edit-page-button
60+
|
61+
| By adding a base URL here, Hyde will use it to create "edit source" links
62+
| to your documentation pages. Hyde expects this to be a GitHub path, but
63+
| it will probably work with other methods as well, if not, send a PR!
64+
|
65+
| You can also change the link text with the `edit_source_link_text` setting.
66+
|
67+
| Example: https://github.com/hydephp/docs/blob/master
68+
| Do not specify the filename or extension, Hyde will do that for you.
69+
| Setting the setting to null will disable the feature.
70+
|
71+
*/
72+
73+
// 'source_file_location_base' => 'https://github.com/<user>/<repo>/<[blob/edit]>/<branch>',
74+
'edit_source_link_text' => 'Edit Source',
75+
'edit_source_link_position' => 'footer', // 'header', 'footer', or 'both'
76+
77+
/*
78+
|--------------------------------------------------------------------------
79+
| Sidebar Page Order
80+
|--------------------------------------------------------------------------
81+
|
82+
| In the generated Documentation pages the navigation links in the sidebar
83+
| default to sort alphabetically. You can reorder the page identifiers
84+
| in the list below, and the links will get sorted in that order.
85+
|
86+
| Internally, the items listed will get a position priority of 500 + the order its found in the list.
87+
| Link items without an entry here will have fall back to the default priority of 999, putting them last.
88+
|
89+
| You can also set explicit priorities in front matter.
90+
|
91+
*/
92+
93+
'sidebar_order' => [
94+
'readme',
95+
'installation',
96+
'getting-started',
97+
],
98+
99+
/*
100+
|--------------------------------------------------------------------------
101+
| Table of Contents Settings
102+
|--------------------------------------------------------------------------
103+
|
104+
| The Hyde Documentation Module comes with a fancy Sidebar that, by default,
105+
| has a Table of Contents included. Here, you can configure its behavior,
106+
| content, look and feel. You can also disable the feature completely.
107+
|
108+
*/
109+
110+
'table_of_contents' => [
111+
'enabled' => true,
112+
'min_heading_level' => 2,
113+
'max_heading_level' => 4,
114+
],
115+
116+
/*
117+
|--------------------------------------------------------------------------
118+
| Search Customization
119+
|--------------------------------------------------------------------------
120+
|
121+
| Hyde comes with an easy to use search feature for documentation pages.
122+
| @see https://hydephp.com/docs/master/documentation-pages#search-feature
123+
|
124+
*/
125+
126+
// Should a docs/search.html page be generated?
127+
'create_search_page' => true,
128+
129+
// Are there any pages you don't want to show in the search results?
130+
'exclude_from_search' => [
131+
'changelog',
132+
],
133+
134+
];

0 commit comments

Comments
 (0)