Skip to content

Commit 3943ae3

Browse files
michalsnmichalsn
committed
update docs
1 parent be0eebc commit 3943ae3

File tree

10 files changed

+160
-34
lines changed

10 files changed

+160
-34
lines changed

‎docs/assets/css/codeigniter.css

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
[data-md-color-scheme="codeigniter"] {
2+
--md-primary-fg-color: #dd4814;
3+
--md-primary-fg-color--light: #ECB7B7;
4+
--md-primary-fg-color--dark: #90030C;
5+
6+
--md-default-bg-color: #fcfcfc;
7+
8+
--md-typeset-a-color: #e74c3c;
9+
--md-accent-fg-color: #97310e;
10+
11+
--md-accent-fg-color--transparent: #ECB7B7;
12+
13+
--md-code-bg-color: #ffffff;
14+
15+
.md-typeset code {
16+
border: 1px solid #e1e4e5;
17+
}
18+
}

‎docs/assets/css/codeigniter_dark_mode.css

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
[data-md-color-scheme="slate"] {
2+
--md-primary-fg-color: #b13a10;
3+
--md-primary-fg-color--light: #8d7474;
4+
--md-primary-fg-color--dark: #6d554d;
5+
6+
--md-default-bg-color: #1e2129;
7+
8+
--md-typeset-a-color: #ed6436;
9+
--md-accent-fg-color: #f18a67;
10+
11+
--md-accent-fg-color--transparent: #625151;
12+
13+
--md-code-bg-color: #282b2d;
14+
15+
.hljs-title,
16+
.hljs-title.class_,
17+
.hljs-title.class_.inherited__,
18+
.hljs-title.function_ {
19+
color: #c9a69b;
20+
}
21+
22+
.hljs-meta .hljs-string,
23+
.hljs-regexp,
24+
.hljs-string {
25+
color: #a3b4c7;
26+
}
27+
28+
.hljs-attr,
29+
.hljs-attribute,
30+
.hljs-literal,
31+
.hljs-meta,
32+
.hljs-number,
33+
.hljs-operator,
34+
.hljs-selector-attr,
35+
.hljs-selector-class,
36+
.hljs-selector-id,
37+
.hljs-variable {
38+
color: #c1b79f;
39+
}
40+
41+
.hljs-doctag,
42+
.hljs-keyword,
43+
.hljs-meta .hljs-keyword,
44+
.hljs-template-tag,
45+
.hljs-template-variable,
46+
.hljs-type,
47+
.hljs-variable.language_ {
48+
color: #c97100;
49+
}
50+
51+
.hljs-subst {
52+
color: #ddba52
53+
}
54+
55+
.md-typeset code {
56+
border: 1px solid #3f4547;
57+
}
58+
59+
.md-typeset .admonition.note,
60+
.md-typeset details.note {
61+
border-color: #2c5293;
62+
}
63+
64+
.md-typeset .note > .admonition-title:before,
65+
.md-typeset .note > summary:before {
66+
background-color: #2c5293;
67+
-webkit-mask-image: var(--md-admonition-icon--note);
68+
mask-image: var(--md-admonition-icon--note);
69+
}
70+
71+
}

‎docs/assets/favicon.ico

4.97 KB
Binary file not shown.

‎docs/assets/flame.svg

Lines changed: 11 additions & 0 deletions
Loading

‎docs/assets/js/hljs.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
document.addEventListener('DOMContentLoaded', (event) => {
2+
hljs.highlightAll();
3+
});

‎docs/commands.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ Here are all the commands you can use with the Queue library.
66

77
Available options:
88

9-
- [queue:publish](#queuePublish)
10-
- [queue:job](#queueJob)
11-
- [queue:work](#queueWork)
12-
- [queue:stop](#queueStop)
13-
- [queue:clear](#queueClear)
14-
- [queue:failed](#queueFailed)
15-
- [queue:retry](#queueRetry)
16-
- [queue:forget](#queueForget)
17-
- [queue:flush](#queueFlush)
9+
- [queue:publish](#queuepublish)
10+
- [queue:job](#queuejob)
11+
- [queue:work](#queuework)
12+
- [queue:stop](#queuestop)
13+
- [queue:clear](#queueclear)
14+
- [queue:failed](#queuefailed)
15+
- [queue:retry](#queueretry)
16+
- [queue:forget](#queueforget)
17+
- [queue:flush](#queueflush)
1818

1919

2020
### queue:publish

‎docs/configuration.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,16 @@ We will get our copy ready for modifications.
1212

1313
Available options:
1414

15-
- [$defaultHandler](#defaultHandler)
15+
- [$defaultHandler](#defaulthandler)
1616
- [$handlers](#handlers)
1717
- [$database](#database)
1818
- [$redis](#redis)
1919
- [$predis](#predis)
20-
- [$keepDoneJobs](#keepDoneJobs)
21-
- [$keepFailedJobs](#keepFailedJobs)
22-
- [$queueDefaultPriority](#queueDefaultPriority)
23-
- [$queuePriorities](#queuePriorities)
24-
- [$jobHandlers](#jobHandlers)
20+
- [$keepDoneJobs](#keepdonejobs)
21+
- [$keepFailedJobs](#keepfailedjobs)
22+
- [$queueDefaultPriority](#queuedefaultpriority)
23+
- [$queuePriorities](#queuepriorities)
24+
- [$jobHandlers](#jobhandlers)
2525

2626
### $defaultHandler
2727

‎docs/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@ Listen for queued jobs.
1414

1515
### Requirements
1616

17-
![PHP](https://img.shields.io/badge/PHP-%5E8.1-blue)
18-
![CodeIgniter](https://img.shields.io/badge/CodeIgniter-%5E4.3-blue)
17+
![PHP](https://img.shields.io/badge/PHP-%5E8.1-red)
18+
![CodeIgniter](https://img.shields.io/badge/CodeIgniter-%5E4.3-red)
1919

2020
### Table of Contents
2121

2222
* [Installation](installation.md)
2323
* [Configuration](configuration.md)
24-
* [Basic usage](basic_usage.md)
25-
* [Running queues](running_queues.md)
24+
* [Basic usage](basic-usage)
25+
* [Running queues](running-queues)
2626
* [Commands](commands.md)
2727
* [Troubleshooting](troubleshooting.md)

‎docs/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
The only thing you have to do is to run this command, and you're ready to go.
1010

11-
composer require michalsn/codeigniter-queue
11+
composer require codeigniter4/queue
1212

1313
## Manual Installation
1414

‎mkdocs.yml

Lines changed: 37 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,30 +9,51 @@ theme:
99
repo: fontawesome/brands/github
1010
palette:
1111
- media: "(prefers-color-scheme: light)"
12-
scheme: default
13-
primary: indigo
14-
accent: indigo
12+
scheme: codeigniter
13+
primary: custom
14+
accent: custom
1515
toggle:
1616
icon: material/brightness-7
1717
name: Switch to dark mode
1818
- media: "(prefers-color-scheme: dark)"
1919
scheme: slate
20-
primary: indigo
21-
accent: indigo
20+
primary: custom
21+
accent: custom
2222
toggle:
2323
icon: material/brightness-4
2424
name: Switch to light mode
25+
features:
26+
- navigation.instant
27+
- navigation.instant.prefetch
28+
- content.code.copy
29+
- navigation.footer
30+
- content.action.edit
31+
- navigation.top
32+
- search.suggest
33+
- search.highlight
34+
- search.share
2535

2636
extra:
27-
homepage: https://michalsn.github.io/codeigniter-queue
37+
homepage: https://codeigniter.com
38+
generator: false
2839

2940
social:
30-
- icon: fontawesome/brands/github
31-
link: https://github.com/michalsn/codeigniter-queue
41+
- icon: material/github
42+
link: https://github.com/codeigniter4/queue
3243
name: GitHub
44+
- icon: material/twitter
45+
link: https://twitter.com/CodeIgniterPhp
46+
name: X
47+
- icon: material/forum
48+
link: https://forum.codeigniter.com
49+
name: Forum Codeigniter
50+
- icon: material/slack
51+
link: https://join.slack.com/t/codeigniterchat/shared_invite/zt-244xrrslc-l_I69AJSi5y2a2RVN~xIdQ
52+
name: Slack
3353

34-
repo_url: https://github.com/michalsn/codeigniter-queue
54+
repo_url: https://github.com/codeigniter4/queue
3555
edit_uri: edit/develop/docs/
56+
copyright: Copyright © 2023 CodeIgniter Foundation.
3657

3758
markdown_extensions:
3859
- admonition
@@ -41,17 +62,19 @@ markdown_extensions:
4162
use_pygments: false
4263

4364
extra_css:
44-
- assets/github-dark-dimmed.css
65+
- https://cdn.jsdelivr.net/gh/highlightjs/[email protected]/build/styles/github.min.css
66+
- assets/css/codeigniter.css
67+
- assets/css/codeigniter_dark_mode.css
4568

4669
extra_javascript:
47-
- https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.6.0/build/highlight.min.js
48-
- assets/hljs.js
70+
- https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.8.0/build/highlight.min.js
71+
- assets/js/hljs.js
4972

5073
nav:
5174
- Home: index.md
5275
- Installation: installation.md
5376
- Configuration: configuration.md
54-
- Basic usage: basic_usage.md
55-
- Running queues: running_queues.md
77+
- Basic usage: basic-usage.md
78+
- Running queues: running-queues.md
5679
- Commands: commands.md
5780
- Troubleshooting: troubleshooting.md

0 commit comments

Comments
 (0)