@compiiile/compiiile 2.18.4 → 2.18.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/4-pro-features.mdx +37 -0
- package/5-pro-slides.mdx +8 -0
- package/README.md +1 -1
- package/package.json +2 -2
package/4-pro-features.mdx
CHANGED
|
@@ -633,3 +633,40 @@ The `CDetails` component allows you to hide a block and reveal it by clicking on
|
|
|
633
633
|
</CDetails>
|
|
634
634
|
```
|
|
635
635
|
</CDetails>
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
### CSlide
|
|
639
|
+
|
|
640
|
+
The `CSlide` component can be used for every slide, it allows you to align content the way you want (horizontally and vertically), and to use custom themes.
|
|
641
|
+
|
|
642
|
+
- The `theme` prop applies a theme to the slide: `catpuccin-mocha`, `catpuccin-macchiato`, `catpuccin-frappe`, `catpuccin-latte`, `beetroot`, `blueberry`, `lemon`, `courgette`, `aubergine`, `carrot`. If not set, the default theme is applied.
|
|
643
|
+
- The `headingSerif` boolean prop changes the headings font to a serif one.
|
|
644
|
+
- The `headingMono` boolean prop changes the headings font to a monospace one.
|
|
645
|
+
- The `align` prop accepts a string with the horizontal and vertical alignement : `<left|center|right|stretch> <top|center|bottom>`, default `center center`.
|
|
646
|
+
- The `textAlign` prop overrides the text alignement for the slide : `left`, `center`, `right`
|
|
647
|
+
- For custom themes, you can provide these props : `textColor`, `backgroundColor`, and `controlsColor` that overrides theme colors.
|
|
648
|
+
|
|
649
|
+
`defaultTheme`, `headingSerif`, `headingMono`, `textColor`, `backgroundColor`, `controlsColor` can also be set in the frontmatter for all `CSlide` components, or be defined in the `site.data.slides` compiiile's config object key.
|
|
650
|
+
|
|
651
|
+
<CDetails summary="Example">
|
|
652
|
+
```mdx
|
|
653
|
+
<CSlide theme="catpuccin-mocha" align="stretch center" controlsColor="#0000FF">
|
|
654
|
+
|
|
655
|
+
# A slide with a custom theme
|
|
656
|
+
|
|
657
|
+
</CSlide>
|
|
658
|
+
```
|
|
659
|
+
</CDetails>
|
|
660
|
+
|
|
661
|
+
|
|
662
|
+
### CGap
|
|
663
|
+
|
|
664
|
+
The `CGap` component can be used in slides, allowing you to add a gap between elements.
|
|
665
|
+
|
|
666
|
+
- The gap can be set with the `width` and `height` prop (accepting CSS values).
|
|
667
|
+
|
|
668
|
+
<CDetails summary="Example">
|
|
669
|
+
```mdx
|
|
670
|
+
<CGap height="100px" />
|
|
671
|
+
```
|
|
672
|
+
</CDetails>
|
package/5-pro-slides.mdx
CHANGED
|
@@ -47,6 +47,14 @@ description: "Use icons, admonitions, mermaid diagrams, markmap mindmaps in Mark
|
|
|
47
47
|
|
|
48
48
|
---
|
|
49
49
|
|
|
50
|
+
<CSlide theme="lemon" headingSerif="true">
|
|
51
|
+
|
|
52
|
+
# Custom themes
|
|
53
|
+
|
|
54
|
+
</CSlide>
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
50
58
|
<CGrid gap="20px" template="1 1">
|
|
51
59
|
<CCard hintText="Go to the specific page">
|
|
52
60
|
[Some link](./3-pro-installation.md)
|
package/README.md
CHANGED
|
@@ -191,7 +191,7 @@ Other frontmatter keys are handled:
|
|
|
191
191
|
- `ignore` : Boolean value (`true` or `false`) to ignore the current file and exclude it from Compiiile (the file is not ignored by default).
|
|
192
192
|
- `hidden` : Boolean value (`true` or `false`) to hide the file from the navbar and siblings links (the file is not hidden by default).
|
|
193
193
|
|
|
194
|
-
> :bulb: You can override slides theme by passing it to a `theme` query parameter in your slide url (for example `/s/slides?theme=light`). See the `theme` config parameter below for valid values.
|
|
194
|
+
> :bulb: You can override slides theme (light or dark) by passing it to a `theme` query parameter in your slide url (for example `/s/slides?theme=light`). See the `theme` config parameter below for valid values.
|
|
195
195
|
|
|
196
196
|
### Routing
|
|
197
197
|
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@compiiile/compiiile",
|
|
3
3
|
"private": false,
|
|
4
|
-
"version": "2.18.
|
|
4
|
+
"version": "2.18.5",
|
|
5
5
|
"description": "The most convenient way to render a folder containing markdown files. Previewing and searching markdown files has never been that easy.",
|
|
6
6
|
"author": "AlbanCrepel <alban.crepel@gmail.com>",
|
|
7
7
|
"license": "GPL-3.0-only",
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
"@babel/eslint-parser": "^7.28.0",
|
|
30
30
|
"@babel/parser": "^7.28.0",
|
|
31
31
|
"@compiiile/compiiile-print": "^1.0.6",
|
|
32
|
-
"@compiiile/compiiile-pro": "^1.
|
|
32
|
+
"@compiiile/compiiile-pro": "^1.3.1",
|
|
33
33
|
"@eslint/compat": "^1.3.1",
|
|
34
34
|
"@eslint/js": "^9.34.0",
|
|
35
35
|
"@fontsource-variable/archivo": "^5.2.6",
|