Skip to content

Commit 721abb7

Browse files
mdomdo
committed
WIP on new .content-body class
1 parent 430026c commit 721abb7

4 files changed

Lines changed: 236 additions & 1 deletion

File tree

‎scss/content/_content-body.scss‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
@use "../config" as *;
2+
@use "../mixins/transition" as *;
3+
4+
@layer content {
5+
.content-body {
6+
--#{$prefix}content-font-size: 16px;
7+
--#{$prefix}content-gap: 24px;
8+
9+
position: relative;
10+
max-width: 1000px;
11+
margin-inline: auto;
12+
font-size: var(--#{$prefix}content-font-size);
13+
line-height: var(--#{$prefix}content-gap);
14+
15+
p,
16+
ul,
17+
ol,
18+
dl,
19+
pre,
20+
table,
21+
blockquote {
22+
margin-bottom: var(--#{$prefix}content-gap);
23+
}
24+
25+
li:not(:last-child) {
26+
margin-bottom: calc(var(--#{$prefix}content-gap) / 4);
27+
}
28+
29+
hr {
30+
margin: calc(var(--#{$prefix}content-gap) * 1.5) 0;
31+
border: 0;
32+
border-top: 1px solid var(--#{$prefix}border-color);
33+
}
34+
35+
h1,
36+
h2,
37+
h3,
38+
h4,
39+
h5,
40+
h6 {
41+
margin-top: 0;
42+
margin-bottom: calc(var(--#{$prefix}content-gap) / 2);
43+
font-weight: 500;
44+
line-height: 1.25;
45+
}
46+
47+
h1 {
48+
font-size: 2.25em;
49+
line-height: 1.1;
50+
}
51+
h2 {
52+
font-size: 1.75em;
53+
}
54+
h3 {
55+
margin-bottom: calc(var(--#{$prefix}content-gap) / 4);
56+
font-size: 1.5em;
57+
}
58+
h4 {
59+
font-size: 1.25em;
60+
}
61+
h5 {
62+
font-size: 1.125em;
63+
}
64+
h6 {
65+
font-size: 1em;
66+
}
67+
68+
a:not([class]) {
69+
color: var(--ui-theme-primary-text);
70+
text-decoration: underline;
71+
text-decoration-color: color-mix(in srgb, var(--ui-theme-primary-text) 25%, transparent);
72+
text-underline-offset: 4px;
73+
@include transition(.1s text-decoration-color ease-in-out);
74+
}
75+
76+
a:not([class]):hover {
77+
text-decoration-color: var(--ui-theme-primary-text);
78+
}
79+
80+
img {
81+
max-width: 100%;
82+
}
83+
84+
blockquote {
85+
padding-left: calc(var(--#{$prefix}content-gap) / 2);
86+
margin: 0;
87+
border-left: 4px solid var(--#{$prefix}border-color);
88+
}
89+
90+
table {
91+
width: 100%;
92+
border-spacing: 0;
93+
border-collapse: collapse;
94+
}
95+
96+
td,
97+
th {
98+
padding: 6px 12px;
99+
text-align: inherit;
100+
border: 1px solid var(--#{$prefix}border-color);
101+
}
102+
103+
dt {
104+
font-weight: 500;
105+
}
106+
107+
video,
108+
img {
109+
max-width: 100%;
110+
}
111+
}
112+
}

‎scss/content/index.scss‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@
22
@forward "type";
33
@forward "tables";
44
@forward "images";
5+
@forward "content-body";

‎site/data/sidebar.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
- title: Images
5353
- title: Tables
5454
- title: Figures
55-
55+
- title: Content body
5656
- title: Forms
5757
icon: ui-radios
5858
icon_color: blue

‎site/src/content/docs/content/content-body.mdx‎

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
---
2+
title: Content body
3+
description: Use the `.content-body` wrapper class to make long form content more easily without the need for specifying Bootstrap classes on every element. Especially useful for converting Markdown or MDX to HTML, or simply for making content heavy pages more readable.
4+
toc: true
5+
---
6+
7+
## How it works
8+
9+
Wrap your content in the `.content-body` class to get modified font-size, line-height, and spacing specifically designed for long form content that originals from source Markdown files or WYSIWYG editors. Here's what we do with that class:
10+
11+
- Set a base `font-size`, `line-height`, and some local CSS variables on the parent element.
12+
- Normalize the spacing of lists
13+
- Set a default `margin-bottom` for headings.
14+
- Style blockquotes, code, and other inline elements.
15+
16+
## Example
17+
18+
This is an example of source Markdown that shows several types of HTML content supported in this `.content-body` wrapper class.
19+
20+
<div class="bd-example content-body">
21+
# Lorem ipsum dolor sit amet
22+
Cum sociis natoque penatibus et magnis [dis parturient montes](#), nascetur ridiculus mus. *Aenean eu leo quam.* Pellentesque ornare sem lacinia quam venenatis vestibulum. Sed posuere consectetur est at lobortis. Cras mattis consectetur purus sit amet fermentum.
23+
24+
> Curabitur blandit tempus porttitor. Nullam quis risus eget urna mollis ornare vel eu leo. Nullam id dolor id nibh ultricies vehicula ut id elit.
25+
26+
Etiam porta **sem malesuada magna** mollis euismod. Cras mattis consectetur purus sit amet fermentum. Aenean lacinia bibendum nulla sed consectetur.
27+
28+
## Inline HTML elements
29+
30+
HTML defines a long list of available inline tags, a complete list of which can be found on the [Mozilla Developer Network](https://developer.mozilla.org/en-US/docs/Web/HTML/Element).
31+
32+
- **To bold text**, use `<strong>`.
33+
- *To italicize text*, use `<em>`.
34+
- <mark>To highlight</mark>, use `<mark>`.
35+
- Abbreviations, like <abbr title="HyperText Markup Langage">HTML</abbr> should use `<abbr>`, with an optional `title` attribute for the full phrase.
36+
- Citations, like <cite>&mdash; Mark Otto</cite>, should use `<cite>`.
37+
- <del>Deleted</del> text should use `<del>` and <ins>inserted</ins> text should use `<ins>`.
38+
- Superscript <sup>text</sup> uses `<sup>` and subscript <sub>text</sub> uses `<sub>`.
39+
40+
Most of these elements are styled by browsers with few modifications on our part.
41+
42+
## Heading
43+
44+
Vivamus sagittis lacus vel augue rutrum faucibus dolor auctor. Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.
45+
46+
### Code
47+
48+
Inline code is available with the `<code>` element. Snippets of multiple lines of code are supported through Rouge. Longer lines will automatically scroll horizontally when needed. You may also use code fencing (triple backticks) for rendering code.
49+
50+
```
51+
// Example can be run directly in your JavaScript console
52+
53+
// Create a function that takes two arguments and returns the sum of those arguments
54+
var adder = new Function("a", "b", "return a + b");
55+
56+
// Call the function
57+
adder(2, 6);
58+
// > 8
59+
```
60+
61+
Aenean lacinia bibendum nulla sed consectetur. Etiam porta sem malesuada magna mollis euismod. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa.
62+
63+
### Lists
64+
65+
Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aenean lacinia bibendum nulla sed consectetur. Etiam porta sem malesuada magna mollis euismod. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus.
66+
67+
- Praesent commodo cursus magna, vel scelerisque nisl consectetur et.
68+
- Donec id elit non mi porta gravida at eget metus.
69+
- Nulla vitae elit libero, a pharetra augue.
70+
71+
Donec ullamcorper nulla non metus auctor fringilla. Nulla vitae elit libero, a pharetra augue.
72+
73+
1. Vestibulum id ligula porta felis euismod semper.
74+
2. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.
75+
3. Maecenas sed diam eget risus varius blandit sit amet non magna.
76+
77+
Cras mattis consectetur purus sit amet fermentum. Sed posuere consectetur est at lobortis.
78+
79+
- Praesent commodo cursus magna, vel scelerisque nisl consectetur et.
80+
- Praesent commodo cursus magna, vel scelerisque nisl consectetur et.
81+
- Donec id elit non mi porta gravida at eget metus.
82+
- Nulla vitae elit libero, a pharetra augue.
83+
- Donec id elit non mi porta gravida at eget metus.
84+
- Nulla vitae elit libero, a pharetra augue.
85+
86+
Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus.
87+
88+
<dl>
89+
<dt>HyperText Markup Language (HTML)</dt>
90+
<dd>The language used to describe and define the content of a Web page</dd>
91+
92+
<dt>Cascading Style Sheets (CSS)</dt>
93+
<dd>Used to describe the appearance of Web content</dd>
94+
95+
<dt>JavaScript (JS)</dt>
96+
<dd>The programming language used to build advanced Web sites and applications</dd>
97+
</dl>
98+
99+
Integer posuere erat a ante venenatis dapibus posuere velit aliquet. Morbi leo risus, porta ac consectetur ac, vestibulum at eros. Nullam quis risus eget urna mollis ornare vel eu leo.
100+
101+
### Images
102+
103+
Quisque consequat sapien eget quam rhoncus, sit amet laoreet diam tempus. Aliquam aliquam metus erat, a pulvinar turpis suscipit at.
104+
105+
![placeholder](http://placehold.it/800x400 "Large example image")
106+
![placeholder](http://placehold.it/400x200 "Medium example image")
107+
![placeholder](http://placehold.it/200x200 "Small example image")
108+
109+
### Tables
110+
111+
Aenean lacinia bibendum nulla sed consectetur. Lorem ipsum dolor sit amet, consectetur adipiscing elit.
112+
113+
| Name | Upvotes | Downvotes |
114+
|---------|---------|-----------|
115+
| Alice | 10 | 11 |
116+
| Bob | 4 | 3 |
117+
| Charlie | 7 | 9 |
118+
| Totals | 21 | 23 |
119+
120+
Nullam id dolor id nibh ultricies vehicula ut id elit. Sed posuere consectetur est at lobortis. Nullam quis risus eget urna mollis ornare vel eu leo.
121+
122+
</div>

0 commit comments

Comments
 (0)