File: _template.md

package info (click to toggle)
textual 2.1.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 55,056 kB
  • sloc: python: 85,423; lisp: 1,669; makefile: 101
file content (70 lines) | stat: -rw-r--r-- 1,721 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
<!-- Template file for a Textual CSS type reference page. -->

# &lt;type-name&gt;

<!-- Short description of the type. -->

## Syntax


<!--
For a simple type like <integer>:

Describe the type in a short paragraph with an absolute link to the type page.
E.g., “The [`<my-type>`](/css_types/my_type) type is such and such with sprinkles on top.”
-->

<!--
For a type with many different values like <color>:

Introduce the type with a link to [`<my-type>`](/css_types/my_type).
Then, a bullet list with the variants accepted:

 - you can create this type with X Y Z;
 - you can also do A B C; and
 - also use D E F.
-->

<!--
For a type that accepts specific options like <border>:

Add a sentence and a table. Consider ordering values in alphabetical order if there is no other obvious ordering. See below:

The [`<my-type>`](/css_types/my_type) type can take any of the following values:

| Value         | Description                                   |
|---------------|-----------------------------------------------|
| `abc`         | Describe here.                                |
| `other val`   | Describe this one also.                       |
| `value three` | Please use full stops.                        |
| `zyx`         | Describe the value without assuming any rule. |
-->


## Examples

### CSS

<!--
Include a good variety of examples.
If the type has many different syntaxes, cover all of them.
Add comments when needed/if helpful.
-->

```css
.some-class {
    rule: type-value-1;
    rule: type-value-2;
    rule: type-value-3;
}
```

### Python

<!-- Same examples as above. -->

```py
widget.styles.rule = type_value_1
widget.styles.rule = type_value_2
widget.styles.rule = type_value_3
```