jekyll-theme-alta-docs 0.2.0 → 0.3.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -7,6 +7,15 @@
7
7
  {% assign current = null %}
8
8
  {% endif %}
9
9
 
10
+ {% assign current_category = null %}
11
+ {% for cat in docs_grouped %}
12
+ {% for doc in cat.items %}
13
+ {% if doc.url == page.url %}
14
+ {% assign current_category = doc.category %}
15
+ {% endif %}
16
+ {% endfor %}
17
+ {% endfor %}
18
+
10
19
  <nav class="ad-site-nav">
11
20
 
12
21
  <a href="/" class="ad-btn-nav-home {{ current }}">
@@ -14,7 +23,11 @@
14
23
  </a>
15
24
 
16
25
  {% for cat in docs_grouped %}
17
- <button class="ad-collapsible">{{ cat.name }}</button>
26
+ {% if current_category == cat.name %}
27
+ <button class="ad-collapsible active">{{ cat.name }}</button>
28
+ {% else %}
29
+ <button class="ad-collapsible">{{ cat.name }}</button>
30
+ {% endif %}
18
31
  <ul class="ad-collapsible-content">
19
32
  {% for doc in cat.items %}
20
33
  {% if doc.url == page.url %}
@@ -42,5 +55,15 @@ for (i = 0; i < coll.length; i++) {
42
55
  content.style.maxHeight = content.scrollHeight + "px";
43
56
  }
44
57
  });
58
+
59
+ // Expand already active category:
60
+ if (coll[i].classList.contains('active')) {
61
+ var content = coll[i].nextElementSibling;
62
+ if (content.style.maxHeight){
63
+ content.style.maxHeight = null;
64
+ } else {
65
+ content.style.maxHeight = content.scrollHeight + "px";
66
+ }
67
+ }
45
68
  }
46
69
  </script>
@@ -0,0 +1,52 @@
1
+ {% assign project_name = 'project-name' %}
2
+ {% if include.project_name %}
3
+ {% assign project_name = include.project_name %}
4
+ {% endif %}
5
+
6
+ ## {{ project_name | capitalize }}
7
+
8
+ The API for {{ project_name }} built with Ruby on Rails.
9
+
10
+
11
+ ### Getting started
12
+
13
+ **Prerequisites:** Ruby, Rails and PostgreSQL are already installed on the machine.
14
+
15
+ 1. Download project (i.e. git clone)
16
+
17
+ 2. Set up environment variables with `dotenv`:
18
+ 2.1 Copy-paste `.env.template` and rename to `.env`.
19
+ 2.2 Open `.env` and set environment variables.
20
+
21
+ 2. Install gems:
22
+
23
+ $ bundle install
24
+
25
+ 3. Set up database:
26
+
27
+ $ rake db:create
28
+ $ rake db:migrate
29
+ $ rake db:seed
30
+
31
+ 4. Run project
32
+
33
+ $ rails s
34
+ # OR
35
+ $ rails s -b xxx.xx.xxx.xx -p 4001
36
+
37
+
38
+ ### Documentation
39
+
40
+ You can find more details about the project in docs repository: **{{ project_name}}-docs**
41
+
42
+ ### Development
43
+
44
+ Follow instructions from [Getting started](#getting-started) to run project.
45
+
46
+ ### Tests
47
+
48
+ TODO
49
+
50
+ ### Deployment
51
+
52
+ TODO
@@ -0,0 +1,54 @@
1
+ {% assign project_name = 'project-name' %}
2
+ {% if include.project_name %}
3
+ {% assign project_name = include.project_name %}
4
+ {% endif %}
5
+
6
+ ## {{ project_name | capitalize }}
7
+
8
+ The web application for {{ project_name }} built with React.JS.
9
+
10
+
11
+ ### Getting started
12
+
13
+ **Prerequisites:** Node.js and npm/yarn/npx already installed.
14
+
15
+ 1. Download project (i.e. git clone)
16
+
17
+ 2. Adjust environment variables in `src/config/*` files.
18
+
19
+ 3. Install:
20
+
21
+ $ yarn install
22
+
23
+ 4. Start project
24
+
25
+ $ yarn start
26
+
27
+
28
+ ### Documentation
29
+
30
+ You can find more details about the project in docs repository: **{{ project_name}}-docs**
31
+
32
+ ### Development
33
+
34
+ Follow instructions from [Getting started](#getting-started) to run project.
35
+
36
+ ### Scripts
37
+
38
+ `yarn start` - start application
39
+
40
+ `yarn test` - test application
41
+
42
+ `yarn build` - build application
43
+
44
+ `yarn lint` - run eslint
45
+
46
+ `yarn format` - format code with Prettier
47
+
48
+ ### Tests
49
+
50
+ TODO
51
+
52
+ ### Deployment
53
+
54
+ TODO
@@ -103,6 +103,10 @@ a.ad-btn-nav-home {
103
103
  }
104
104
 
105
105
  h1 {
106
+ font-family: $font-family-primary;
107
+ font-size: 42px;
108
+ text-transform: uppercase;
109
+ font-weight: 800;
106
110
  i.fas, .symbol {
107
111
  font-size: 20px;
108
112
  margin-right: 7px;
@@ -110,6 +114,11 @@ h1 {
110
114
  }
111
115
 
112
116
  h2 {
117
+ margin-top: 60px;
118
+ margin-bottom: 15px;
119
+ font-size: 32px;
120
+ font-family: $font-family-primary;
121
+ border-bottom: 1px solid $gray-400;
113
122
  i.fas, .symbol {
114
123
  font-size: 16px;
115
124
  margin-right: 5px;
@@ -117,12 +126,37 @@ h2 {
117
126
  }
118
127
 
119
128
  h3 {
129
+ margin-top: 40px;
130
+ margin-bottom: 10px;
131
+ font-size: 20px;
132
+ font-family: $font-family-primary;
133
+ i.fas, .symbol {
134
+ font-size: 14px;
135
+ margin-right: 5px;
136
+ }
137
+ }
138
+
139
+ h4 {
140
+ margin-top: 30px;
141
+ margin-bottom: 5px;
142
+ font-family: $font-family-primary;
143
+ font-weight: 600;
120
144
  i.fas, .symbol {
121
145
  font-size: 14px;
122
146
  margin-right: 5px;
123
147
  }
124
148
  }
125
149
 
150
+ p + ul {
151
+ margin-top: 5px;
152
+ margin-bottom: 20px;
153
+ }
154
+
155
+ p {
156
+ margin-top: 15px;
157
+ margin-bottom: 5px;
158
+ }
159
+
126
160
  hr {
127
161
  height: 1px;
128
162
  background-color: $gray-400;
@@ -311,7 +345,7 @@ button.ad-collapsible, .ad-collapsible {
311
345
  list-style: none;
312
346
  margin: 0;
313
347
  ul {
314
- padding-left: 15px;
348
+ padding-left: 25px;
315
349
  list-style: none;
316
350
  }
317
351
  }
@@ -329,7 +363,7 @@ button.ad-collapsible, .ad-collapsible {
329
363
  border: 1px solid $gray-400;
330
364
  box-sizing: border-box;
331
365
  border-spacing: 0;
332
- font-size: 13px;
366
+ font-size: 14px;
333
367
  td, th {
334
368
  border-right: 1px solid $gray-400;
335
369
  border-bottom: 1px solid $gray-400;
@@ -376,7 +410,7 @@ button.ad-collapsible, .ad-collapsible {
376
410
  justify-content: flex-start;
377
411
  flex-wrap: wrap;
378
412
  .ad-system_component {
379
- min-width: 200px;
413
+ min-width: 120px;
380
414
  flex: 1;
381
415
  display: flex;
382
416
  flex-direction: column;
@@ -466,3 +500,43 @@ pre.highlight {
466
500
  }
467
501
 
468
502
  }
503
+
504
+ .highlighter-rouge.language-scss {
505
+ .c1 {
506
+ color: #aaa;
507
+ }
508
+ .nv {
509
+ color: #e00bbc;
510
+ font-weight: bold;
511
+ }
512
+ .nt {
513
+ color: #0b11d8;
514
+ font-weight: bold;
515
+ }
516
+ .nc {
517
+ color: #cea513;
518
+ font-weight: bold;
519
+ }
520
+ }
521
+
522
+ .highlighter-rouge.language-ruby {
523
+ .n { color: blue; }
524
+ .ss { color: #34bad8; }
525
+ .s1 { color: #189c41; }
526
+ .c1 { color: #aaa; }
527
+ }
528
+
529
+ .highlighter-rouge.language-bash {
530
+ .nv { color: blue; }
531
+ .nb { color: #189c41; }
532
+ .nt { color: #34bad8; }
533
+ .c { color: #aaa; }
534
+ }
535
+
536
+ .highlighter-rouge.language-javascript {
537
+ .nv { color: #cea513; }
538
+ .nx { color: blue; }
539
+ .nt { color: #34bad8; }
540
+ .c1 { color: #aaa; }
541
+ .kd { color: #cea513; font-weight: bold; }
542
+ }
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jekyll-theme-alta-docs
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.0
4
+ version: 0.3.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tom Antas
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-09-02 00:00:00.000000000 Z
11
+ date: 2020-09-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: jekyll
@@ -90,6 +90,13 @@ files:
90
90
  - LICENSE.txt
91
91
  - README.md
92
92
  - _includes/footer.html
93
+ - _includes/guidelines/rails/api_only_project_tree.md
94
+ - _includes/guidelines/rails/api_only_project_tree_with_files.md
95
+ - _includes/guidelines/rails/api_only_psql_no_admin_setup_instructions.md
96
+ - _includes/guidelines/rails/rails_cheatsheet.md
97
+ - _includes/guidelines/react/react_csr_setup_instructions.md
98
+ - _includes/guidelines/react/react_guidelines.md
99
+ - _includes/guidelines/react/react_project_tree.md
93
100
  - _includes/head.html
94
101
  - _includes/head_scripts.html
95
102
  - _includes/nav.html
@@ -98,6 +105,8 @@ files:
98
105
  - _includes/scripts.html
99
106
  - _includes/sidebar.html
100
107
  - _includes/system_components_overview.html
108
+ - _includes/templates/rails/rails_readme.md
109
+ - _includes/templates/react/react_readme.md
101
110
  - _includes/useful_links.html
102
111
  - _layouts/default.html
103
112
  - _layouts/doc.html