Skip to content

Commit e59f65e

Browse files
committed
pretty up docs
1 parent 3f80e5e commit e59f65e

File tree

11 files changed

+1301
-399
lines changed

11 files changed

+1301
-399
lines changed

.idea/.gitignore

+8
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/docs.iml

+8
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/inspectionProfiles/Project_Default.xml

+861
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/modules.xml

+8
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/php.xml

+20
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/vcs.xml

+6
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Binary file not shown.

_sidebar.md

-3
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,6 @@
1515
- [API Endpoints](api/README.md)
1616
- [Event Hooks/Filters](technical/hooks.md)
1717
- [Source Code](technical/README.md)
18-
19-
**Getting Started**
20-
- [Quick Start](getting-started/new-project.md)
2118

2219
**External Links**
2320
- [Github Repository](https://github.com/Leantime/leantime/)

api/README.md

+23-25
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Leantime Api
33
footer: false
44
---
55

6-
# Leantime Api
6+
# Leantime Api jsonRPC method namespaces
77

88
For an introduction into connecting to the Leantime API please see [Api Usage](https://docs.leantime.io/#/api/usage)
99

@@ -12,59 +12,57 @@ RPC Methods are the primary endpoint definition and follow the structure
1212

1313
If `Module` and `Service` have the same name they can be summarized to `leantime.rpc`.`servicee`.`method`
1414

15-
## jsonRPC method namespaces
1615

17-
18-
### `leantime.rpc.Calendar`
16+
## `leantime.rpc.Calendar`
1917

2018

2119
| Available Services | Description |
2220
|--- |--- |
2321
| [Calendar](api/classes/Leantime/Domain/Calendar/Services/Calendar.md) | |
2422

25-
### `leantime.rpc.Canvas`
23+
## `leantime.rpc.Canvas`
2624

2725

2826
| Available Services | Description |
2927
|--- |--- |
3028
| [Canvas](api/classes/Leantime/Domain/Canvas/Services/Canvas.md) | |
3129

32-
### `leantime.rpc.Clients`
30+
## `leantime.rpc.Clients`
3331

3432

3533
| Available Services | Description |
3634
|--- |--- |
3735
| [Clients](api/classes/Leantime/Domain/Clients/Services/Clients.md) | Class Clients|
3836

39-
### `leantime.rpc.Comments`
37+
## `leantime.rpc.Comments`
4038

4139

4240
| Available Services | Description |
4341
|--- |--- |
4442
| [Comments](api/classes/Leantime/Domain/Comments/Services/Comments.md) | |
4543

46-
### `leantime.rpc.Files`
44+
## `leantime.rpc.Files`
4745

4846

4947
| Available Services | Description |
5048
|--- |--- |
5149
| [Files](api/classes/Leantime/Domain/Files/Services/Files.md) | |
5250

53-
### `leantime.rpc.Goalcanvas`
51+
## `leantime.rpc.Goalcanvas`
5452

5553

5654
| Available Services | Description |
5755
|--- |--- |
5856
| [Goalcanvas](api/classes/Leantime/Domain/Goalcanvas/Services/Goalcanvas.md) | |
5957

60-
### `leantime.rpc.Ideas`
58+
## `leantime.rpc.Ideas`
6159

6260

6361
| Available Services | Description |
6462
|--- |--- |
6563
| [Ideas](api/classes/Leantime/Domain/Ideas/Services/Ideas.md) | |
6664

67-
### `leantime.rpc.Notifications`
65+
## `leantime.rpc.Notifications`
6866

6967

7068
| Available Services | Description |
@@ -73,99 +71,99 @@ If `Module` and `Service` have the same name they can be summarized to `leantime
7371
| [News](api/classes/Leantime/Domain/Notifications/Services/News.md) | |
7472
| [Notifications](api/classes/Leantime/Domain/Notifications/Services/Notifications.md) | |
7573

76-
### `leantime.rpc.Oidc`
74+
## `leantime.rpc.Oidc`
7775

7876

7977
| Available Services | Description |
8078
|--- |--- |
8179
| [Oidc](api/classes/Leantime/Domain/Oidc/Services/Oidc.md) | |
8280

83-
### `leantime.rpc.Plugins`
81+
## `leantime.rpc.Plugins`
8482

8583

8684
| Available Services | Description |
8785
|--- |--- |
8886
| [Plugins](api/classes/Leantime/Domain/Plugins/Services/Plugins.md) | |
8987
| [Premium](api/classes/Leantime/Domain/Plugins/Services/Premium.md) | |
9088

91-
### `leantime.rpc.Projects`
89+
## `leantime.rpc.Projects`
9290

9391

9492
| Available Services | Description |
9593
|--- |--- |
9694
| [Projects](api/classes/Leantime/Domain/Projects/Services/Projects.md) | |
9795

98-
### `leantime.rpc.Queue`
96+
## `leantime.rpc.Queue`
9997

10098

10199
| Available Services | Description |
102100
|--- |--- |
103101
| [Queue](api/classes/Leantime/Domain/Queue/Services/Queue.md) | |
104102

105-
### `leantime.rpc.Reactions`
103+
## `leantime.rpc.Reactions`
106104

107105

108106
| Available Services | Description |
109107
|--- |--- |
110108
| [Reactions](api/classes/Leantime/Domain/Reactions/Services/Reactions.md) | |
111109

112-
### `leantime.rpc.Reports`
110+
## `leantime.rpc.Reports`
113111

114112

115113
| Available Services | Description |
116114
|--- |--- |
117115
| [Reports](api/classes/Leantime/Domain/Reports/Services/Reports.md) | |
118116

119-
### `leantime.rpc.Setting`
117+
## `leantime.rpc.Setting`
120118

121119

122120
| Available Services | Description |
123121
|--- |--- |
124122
| [Setting](api/classes/Leantime/Domain/Setting/Services/Setting.md) | |
125123

126-
### `leantime.rpc.Sprints`
124+
## `leantime.rpc.Sprints`
127125

128126

129127
| Available Services | Description |
130128
|--- |--- |
131129
| [Sprints](api/classes/Leantime/Domain/Sprints/Services/Sprints.md) | |
132130

133-
### `leantime.rpc.Tags`
131+
## `leantime.rpc.Tags`
134132

135133

136134
| Available Services | Description |
137135
|--- |--- |
138136
| [Tags](api/classes/Leantime/Domain/Tags/Services/Tags.md) | |
139137

140-
### `leantime.rpc.Tickets`
138+
## `leantime.rpc.Tickets`
141139

142140

143141
| Available Services | Description |
144142
|--- |--- |
145143
| [Tickets](api/classes/Leantime/Domain/Tickets/Services/Tickets.md) | |
146144

147-
### `leantime.rpc.Timesheets`
145+
## `leantime.rpc.Timesheets`
148146

149147

150148
| Available Services | Description |
151149
|--- |--- |
152150
| [Timesheets](api/classes/Leantime/Domain/Timesheets/Services/Timesheets.md) | |
153151

154-
### `leantime.rpc.Users`
152+
## `leantime.rpc.Users`
155153

156154

157155
| Available Services | Description |
158156
|--- |--- |
159157
| [Users](api/classes/Leantime/Domain/Users/Services/Users.md) | |
160158

161-
### `leantime.rpc.Widgets`
159+
## `leantime.rpc.Widgets`
162160

163161

164162
| Available Services | Description |
165163
|--- |--- |
166164
| [Widgets](api/classes/Leantime/Domain/Widgets/Services/Widgets.md) | |
167165

168-
### `leantime.rpc.Wiki`
166+
## `leantime.rpc.Wiki`
169167

170168

171169
| Available Services | Description |

index.html

+27-28
Original file line numberDiff line numberDiff line change
@@ -15,31 +15,33 @@
1515
<meta charset="UTF-8">
1616
<link rel="shortcut icon" href="/favicon.ico"/>
1717
<link rel="apple-touch-icon" href="/apple-touch-icon.png">
18+
1819
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple.css">
1920

21+
2022
<style>
2123
:root {
22-
--base-font-size: 14px;
2324
--theme-color : #006C9E;
25+
--base-font-size : 14px;
26+
--content-max-width: 60em;
27+
--sidebar-width: 20rem;
2428
}
2529

30+
/* Top nav bar - Plugin */
2631
nav {
27-
border-bottom:1px solid #ddd;
2832
}
2933

3034
nav a {
3135
display:inline-block;
3236
padding:0px 10px;
33-
color:#1b75bb;
37+
color:#006C9E;
3438
}
3539

3640
nav a:hover {
37-
color:#333;
41+
text-decoration:underline;
3842
}
3943

40-
section.content {
41-
padding-top:12px;
42-
}
44+
4345

4446
.markdown-section > div:first-child {
4547
float:right;
@@ -68,35 +70,21 @@
6870
el: '#main',
6971
loadSidebar: true,
7072
loadNavbar: true,
71-
autoHeader: false,
7273
name: 'Leantime',
73-
logo: '/_images/leantime_logo.png',
74+
logo: '/_images/leantime-gradient-logo-350-100-transparent.webp',
7475
relativePath: false,
7576
themeable: {
7677
readyTransition : true, // default
7778
responsiveTables: true // default
7879
},
7980
auto2top : true,
8081
maxLevel : 3,
81-
subMaxLevel: 3,
82+
subMaxLevel: 2,
8283
plugins: [
83-
EditOnGithubPlugin.create('https://github.com/Leantime/docs/edit/master/', null, '<img src="_images/icons/github.svg" style="vertical-align: text-bottom"/> Edit on Github'),
84-
function (hook) {
85-
var footer = [
86-
'<hr/>',
87-
'<footer>',
88-
'<span><a href="https://leantime.io">Leantime</a> &copy;2024. </span>',
89-
'<span>Proudly published with <a href="https://github.com/docsifyjs/docsify/" target="_blank">docsify</a>.</span>',
90-
'</footer>'
91-
].join('')
92-
93-
hook.afterEach(function (html) {
94-
return html + footer
95-
})
96-
}
84+
9785
],
9886
search: {
99-
maxAge: 5000, // Expiration time, the default one day
87+
maxAge: 1000, // Expiration time, the default one day
10088
paths: 'auto', // or 'auto'
10189
placeholder: 'Type to search',
10290

@@ -108,15 +96,26 @@
10896
hideOtherSidebarContent: false, // whether or not to hide other sidebar content
10997

11098
}, // default
99+
pagination: {
100+
previousText: 'previous',
101+
// or
102+
nextText: 'next',
103+
crossChapter: true,
104+
crossChapterText: true,
105+
},
111106

112107
}
113108
</script>
114-
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
115-
<script src="https://cdn.jsdelivr.net/npm/docsify-themeable@0"></script>
109+
<script src="https://cdn.jsdelivr.net/npm/docsify@4"></script>
110+
<script src="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/js/docsify-themeable.min.js"></script>
111+
116112
<script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/plugins/search.js"></script>
117-
<script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/plugins/zoom-image.min.js"></script>
113+
<script src="https://unpkg.com/docsify-pagination/dist/docsify-pagination.min.js"></script>
114+
<script src="https://unpkg.com/docsify-copy-code@2"></script>
115+
118116
<script src="//unpkg.com/prismjs/components/prism-php.min.js"></script>
119117
<script src="//unpkg.com/prismjs/components/prism-json.min.js"></script>
118+
120119

121120

122121

0 commit comments

Comments
 (0)