Skip to content

Commit a929a70

Browse files
committed
Update documentation structure for better search results
1 parent 2b7057a commit a929a70

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+648
-669
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,14 @@ Manually load `/build/index.html` in your browser to view your local build. For
3838

3939
First you will need to choose a docsearch index name to use for your local testing and set that in `config.yml`
4040

41-
Then you will need to build the docs and serve a local copy. For simplicity's sake we recommend using the node http-server like this `npx http-server -o ./build`
41+
Then you will need to build the docs and serve a local copy. For simplicity's sake we recommend using the node http-server like this `npx http-server -o`
4242

4343
Next you will need to update all the urls in `search.config.json` to point at your local copy of the documentation. Do a find/replace on `https://docs.expressionengine.com/latest` => `http://localhost:8080`. You will also need to update the `allowed_domains` array to include this new url. (If you are on a mac you may need to use `http://host.docker.internal:8080` instead so that the scraper container can connect to the docs on your local http-server.)
4444

4545
Finally you can scrape your local docs with the following docker command
4646

4747
```
48-
docker run -t --rm --network=host
48+
docker run -t --rm --network=host \
4949
-e MEILISEARCH_HOST_URL=https://docsearch.expressionengine.com \
5050
-e MEILISEARCH_API_KEY={{ SECRET_KEY }} \
5151
-v ./search.config.json:/docs-scraper/search.config.json \

docs/development/control-panel-js/globals.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,56 +20,56 @@ The elements of global `EE` JavaScript objects could vary depending on the Contr
2020

2121
To add the element to global object, call [`ee()->javascript->set_global()`](development/legacy/libraries/javascript.md#set_globalvar-val--) function.
2222

23-
### `BASE`
23+
## `BASE`
2424

2525
Control Panel base URL.
2626

2727
$.get(EE.BASE + '&C=login&M=lock_cp');
2828

29-
### `CSRF_TOKEN`
29+
## `CSRF_TOKEN`
3030

3131
The current [Cross Site Request Forgery](development/guidelines/security.md#cross-site-request-forgery) token
3232

3333
headers: { 'X-CSRF-TOKEN': EE.CSRF_TOKEN },
3434

35-
### `PATH_CP_GBL_IMG`
35+
## `PATH_CP_GBL_IMG`
3636

3737
Path to `themes/ee/asset/img` directory
3838

39-
### `THEME_URL`
39+
## `THEME_URL`
4040

4141
URL to `themes/ee/cp` folder
4242

43-
### `username`
43+
## `username`
4444

4545
Username of currently logged in member
4646

47-
### `lang`
47+
## `lang`
4848

4949
Object of language strings available for JavaScript function in member's preferred language
5050

5151
text: EE.lang.loading
5252

53-
### `hasRememberMe`
53+
## `hasRememberMe`
5454

5555
Indicates whether the "remember me" checkbox was toggled on when member logged in.
5656

57-
### `cp.appVer`
57+
## `cp.appVer`
5858

5959
The version number of ExpressionEngine release.
6060
data: {
6161
appVer: EE.cp.appVer,
6262
}
6363

64-
### `site_id`
64+
## `site_id`
6565

6666
ID of MSM site that is currently active in Control Panel
6767

68-
### `site_name`
68+
## `site_name`
6969

7070
The configured site name
7171

72-
### `site_url`
72+
## `site_url`
7373

7474
The URL to the site's front-end
7575

@@ -81,7 +81,7 @@ The URL to the site's front-end
8181
}
8282
]
8383

84-
### `fileManagerCompatibilityMode`
84+
## `fileManagerCompatibilityMode`
8585

8686
Indicates whether File Manager is running in [Compatibility Mode](control-panel/file-manager/file-manager.md#compatibility-mode).
8787

docs/development/extension-hooks/api/channel-fields.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ lang: php
1313

1414
# Channel Fields API Extension Hooks
1515

16-
### `custom_field_modify_data(EE_Fieldtype $ft, $method, $data)`
16+
## `custom_field_modify_data(EE_Fieldtype $ft, $method, $data)`
1717

1818
| Parameter | Type | Description |
1919
| --------- | -------- | --------------------------------------------------- |

docs/development/extension-hooks/api/template-structure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@
99

1010
# Template Structure API Extension Hooks
1111

12-
### `template_types`
12+
## `template_types`
1313

1414
See the Output library's [template_types](development/extension-hooks/cp/design.md#template_types).

docs/development/extension-hooks/cp/admin-content.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ lang: php
1313

1414
# Admin Content Controller Extension Hooks
1515

16-
[TOC=3]
16+
[TOC=2]
1717

18-
### `category_delete($cat_ids)`
18+
## `category_delete($cat_ids)`
1919

2020
| Parameter | Type | Description |
2121
| --------- | ------- | ----------------------------------- |
@@ -28,7 +28,7 @@ How it's called:
2828

2929
ee()->extensions->call('category_delete', $cat_ids);
3030

31-
### `category_save($cat_id, $data)`
31+
## `category_save($cat_id, $data)`
3232

3333
| Parameter | Type | Description |
3434
| --------------- | ------- | -------------------- |
@@ -42,6 +42,6 @@ How it's called:
4242

4343
ee()->extensions->call('category_save', $cat_id, $category_data);
4444

45-
### `foreign_character_conversion_array`
45+
## `foreign_character_conversion_array`
4646

4747
See Content_publish's `foreign_character_conversion_array`.

docs/development/extension-hooks/cp/css.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ lang: php
1313

1414
# CSS Controller Extension Hooks
1515

16-
### `cp_css_end()`
16+
## `cp_css_end()`
1717

1818
| Parameter | Type | Description |
1919
| --------- | -------- | -------------------------------------- |

docs/development/extension-hooks/cp/design.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ lang: php
1313

1414
# Design Controller Extension Hooks
1515

16-
### `template_types()`
16+
## `template_types()`
1717

1818
| Parameter | Type | Description |
1919
| --------- | ------- | -------------------------------------- |

docs/development/extension-hooks/cp/javascript.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ lang: php
1313

1414
# Javascript Controller Extension Hooks
1515

16-
### `cp_js_end()`
16+
## `cp_js_end()`
1717

1818
| Parameter | Type | Description |
1919
| --------- | -------- | ------------------------------------------------- |

docs/development/extension-hooks/cp/login.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ lang: php
1313

1414
# Login Controller Extension Hooks
1515

16-
[TOC=3]
16+
[TOC=2]
1717

18-
### `login_authenticate_start()`
18+
## `login_authenticate_start()`
1919

2020
| Parameter | Type |
2121
| --------- | ------ |
@@ -28,7 +28,7 @@ How it's called:
2828
$this->extensions->call('login_authenticate_start');
2929
if ($this->extensions->end_script === TRUE) return;
3030

31-
### `cp_member_login($hook_data)`
31+
## `cp_member_login($hook_data)`
3232

3333
| Parameter | Type | Description |
3434
| ----------- | -------- | ---------------------------------------------------------------------------------------------------------------- |
@@ -42,7 +42,7 @@ How it's called:
4242
ee()->extensions->call('cp_member_login', $this->_hook_data());
4343
if (ee()->extensions->end_script === TRUE) return;
4444

45-
### `cp_member_logout()`
45+
## `cp_member_logout()`
4646

4747
| Parameter | Type |
4848
| --------- | ------ |
@@ -55,7 +55,7 @@ How it's called:
5555
$this->extensions->call('cp_member_logout');
5656
if ($this->extensions->end_script === TRUE) return;
5757

58-
### `cp_member_reset_password()`
58+
## `cp_member_reset_password()`
5959

6060
| Parameter | Type |
6161
| --------- | ------ |

docs/development/extension-hooks/cp/members.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ lang: php
1313

1414
# Members Controller Extension Hooks
1515

16-
[TOC=3]
16+
[TOC=2]
1717

18-
### `cp_members_member_create_start()`
18+
## `cp_members_member_create_start()`
1919

2020
| Parameter | Type |
2121
| --------- | ------ |
@@ -28,7 +28,7 @@ How it's called:
2828
$this->extensions->call('cp_members_member_create_start');
2929
if ($this->extensions->end_script === TRUE) return;
3030

31-
### `cp_members_member_create($member_id, $data)`
31+
## `cp_members_member_create($member_id, $data)`
3232

3333
| Parameter | Type | Description |
3434
| ----------- | ------- | ----------------- |
@@ -43,7 +43,7 @@ How it's called:
4343
$this->extensions->call('cp_members_member_create', $member_id, $data);
4444
if ($this->extensions->end_script === TRUE) return;
4545

46-
### `cp_members_member_delete_end($member_ids)`
46+
## `cp_members_member_delete_end($member_ids)`
4747

4848
| Parameter | Type | Description |
4949
| ------------ | ------- | ---------------------- |
@@ -57,7 +57,7 @@ How it's called:
5757
$this->extensions->call('cp_members_member_delete_end', $member_ids);
5858
if ($this->extensions->end_script === TRUE) return;
5959

60-
### `cp_members_validate_members()`
60+
## `cp_members_validate_members()`
6161

6262
| Parameter | Type | Description |
6363
| --------- | ------- | ------------------------------ |

0 commit comments

Comments
 (0)