Skip to content

Commit 658dc21

Browse files
committed
📚 DOCS: Add more sphinx-panels migration tips
1 parent ed53327 commit 658dc21

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

docs/get_started.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,9 @@ These are replaced by the use of directive options, which are:
7474
The `panel` directive is replaced by the use of the top-level `grid` directive,
7575
then using `grid-item-card` directive children, rather than delimiting cards by `---`.
7676

77-
If no card is needed, then the `grid-item` directive can be used instead
78-
and `card` can be also used independently of grids.
77+
If no card is needed, then the `grid-item` directive can be used instead and `card` can be also used independently of grids.
78+
79+
Approximately, `.. panels::` is equivalent to `.. grid:: 1 2 2 2` with option `:gutter: 2`.
7980

8081
### `tabbed` directive replaced
8182

@@ -86,12 +87,21 @@ The `:sync:` option allows to synchronize tab selection across sets.
8687

8788
The `tab-set-code` directive provides a shorthand for synced code examples.
8889

90+
### `link-button` directive replaced
91+
92+
The `link-button` directive is replaced by the use of `button-ref`/`button-link`.
93+
94+
Directive options have also been added to replace the use of classes:
95+
96+
- `stretched-link` -> `:click-parent:`
97+
- `btn-block` -> `:expand:`
98+
8999
### `octicon` icon role
90100

91101
The default SVGs produced are now sized relative to the surrounding text (i.e. using `1em`).
92102
The syntax for specifying a custom size and adding classes is also changed.
93103

94-
This is similar for favicon icons.
104+
This is similar for favicon icons, where the `,` delimiter is also replaced by `;`, e.g. ``:fa:`name,class` `` -> ``:fa:`name;class` ``.
95105

96106
### Improved CSS
97107

0 commit comments

Comments
 (0)