Skip to content

Commit f25b932

Browse files
committed
update docs
1 parent a42c554 commit f25b932

File tree

3 files changed

+54
-42
lines changed

3 files changed

+54
-42
lines changed

README.md

Lines changed: 47 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,13 @@ presenter: <name-of-the-presenter>
6565
logo: <path-to-logo>
6666
color: <font-color-for-slide-title>
6767
footer: <footer-content>
68-
aboutUs: <content-for-about-us-slide>
68+
aboutUs:
69+
- title: <about-us-title1>
70+
text: <text-for-title1>
71+
- title: <about-us-title2>
72+
text: <text-for-title2>
73+
- title: <about-us-title3>
74+
text: <text-for-title3>
6975
---
7076
```
7177

@@ -75,10 +81,12 @@ These are the supported metadata required for the presentation template.
7581
|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
7682
| `slide` | Default slide for presentation. Most used slide template can be given in the default metadata. |
7783
| `presenter` | Name of the presenter. |
78-
| `logo` | Logo of the company. Logo appears on the top right corner of the slide |
84+
| `logo` | Logo appears on the top right corner of the slide. The logo path should be relative to the markdown file. |
7985
| `color` | Font color of the slide title. |
8086
| `footer` | Content to be shown in the footer of the slide. |
8187
| `aboutUs` | Column wise content to be shown in the about-us slide. Use this metadata only if about-us slide is used for the presentation. More [here](#slide-about-us) |
88+
| `aboutUs:title` | Title for each column in about-us slide. |
89+
| `aboutUs:text` | Text under each title for column in about-us slide. |
8290

8391
Following the front matter, create slides as described in [Creating Presentation](#creating-presentation)
8492

@@ -107,10 +115,16 @@ default metadata, so you don't need to add the slide metadata in every slide.
107115
| `cover` | This slide template can be used for cover slide | `::slide:cover` |
108116
| `title-content` | The slide with title and content (content can be image as well) | `::slide:title-content` |
109117
| `title-content-image` | The slide with title, and content in left and image in right | `::slide:title-content-image` |
110-
| `about-us` | The slide with company info (e.g., Values, mission, Vision) | `::slide:about-us` |
118+
| `about-us` | The slide with about-us info (e.g., Values, mission, Vision) | `::slide:about-us` |
111119

112120
#### Slide "Cover"
113121

122+
Code:
123+
124+
```markdown
125+
# TITLE ::slide:cover
126+
```
127+
114128
Preview:
115129

116130
```text
@@ -127,13 +141,15 @@ Preview:
127141
└────────────────────────────────────────────────────┘
128142
```
129143

144+
#### Slide "title-content"
145+
130146
Code:
131147

132148
```markdown
133-
# TITLE ::slide:cover
134-
```
149+
# TITLE ::slide:title-content
135150

136-
#### Slide "title-content"
151+
CONTENT
152+
```
137153

138154
Preview:
139155

@@ -151,15 +167,17 @@ Preview:
151167
└────────────────────────────────────────────────────┘
152168
```
153169

170+
Image can also be included in the content of the slide.
171+
154172
Code:
155173

156174
```markdown
157-
# TITLE ::slide:title-content
175+
# TITLE ::slide:title-image
158176

159177
CONTENT
160-
```
161178

162-
Image can also be included in the content of the slide.
179+
![This is image description](./image.png)
180+
```
163181

164182
Preview:
165183

@@ -177,18 +195,18 @@ Preview:
177195
└────────────────────────────────────────────────────┘
178196
```
179197

198+
#### Slide "title-content-image"
199+
180200
Code:
181201

182202
```markdown
183-
# TITLE ::slide:title-image
203+
# TITLE ::slide:title-content-image
184204

185205
CONTENT
186206

187-
![This is image description](./image.png)
207+
![This is image description](image.png)
188208
```
189209

190-
#### Slide "title-content-image"
191-
192210
Preview:
193211

194212
```text
@@ -205,17 +223,29 @@ Preview:
205223
└────────────────────────────────────────────────────┘
206224
```
207225

226+
#### Slide "about-us"
227+
208228
Code:
209229

210230
```markdown
211-
# TITLE ::slide:title-content-image
231+
# TITLE ::slide:about-us
212232

213233
CONTENT
214-
215-
![This is image description](image.png)
216234
```
217235

218-
#### Slide "about-us"
236+
The `title` and `text` can be provided via default metadat in front matter as:
237+
238+
```markdown
239+
---
240+
aboutUs:
241+
- title: Title 1
242+
text: Some text under title 1
243+
- title: Title 2
244+
text: Some text under title 2
245+
- title: Title 3
246+
text: Some text under title 3
247+
---
248+
```
219249

220250
Preview:
221251

@@ -237,28 +267,6 @@ Preview:
237267
└────────────────────────────────────────────────────┘
238268
```
239269

240-
Code:
241-
242-
```markdown
243-
# TITLE ::slide:about-us
244-
245-
CONTENT
246-
```
247-
248-
The `title` and `text` can be provided via default metadat in front matter as:
249-
250-
```markdown
251-
---
252-
aboutUs:
253-
- title: Title 1
254-
text: Some text under title 1
255-
- title: Title 2
256-
text: Some text under title 2
257-
- title: Title 3
258-
text: Some text under title 3
259-
---
260-
```
261-
262270
## Development
263271

264272
> [!IMPORTANT] When switching between OpenCloud and oCIS, make sure to clean the browser cache!

src/App.vue

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -380,6 +380,12 @@ function setFontColor() {
380380
slideContainer.value.querySelectorAll('.title p, h1').forEach((el) => {
381381
el.style.color = color
382382
})
383+
slideContainer.value.querySelectorAll('.about-us-text').forEach((el) => {
384+
el.style.backgroundColor = color
385+
})
386+
slideContainer.value.querySelectorAll('.info-box h3').forEach((el) => {
387+
el.style.color = color
388+
})
383389
}
384390
function applyTemplateIfNeeded() {
385391
const frontMatter = getFrontMatterFromMarkdown()

src/css/templates.css

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,6 @@ footer {
171171
}
172172

173173
.about-us-text {
174-
background-color: rgba(32, 67, 79, 0.8);
175174
width: 100%;
176175
color: #fff;
177176
text-align: center;
@@ -192,13 +191,12 @@ footer {
192191
}
193192

194193
.info-box h3 {
195-
color: #20434f;
196194
margin: 10px 0;
197195
}
198196

199197
.divider {
200198
width: 1px;
201-
background-color: #20434f;
199+
background-color: #000000;
202200
opacity: 0.5;
203201
align-self: stretch;
204202
}

0 commit comments

Comments
 (0)