mirror of
https://github.com/snachodog/just-the-docs.git
synced 2025-04-23 19:42:23 -06:00
a789198b20
In touching up the migration guide, I noticed that many of our documentation site links are broken! For example, on the homepage, this link: <img width="782" alt="screenshot of homepage; code snippet is in next block" src="https://user-images.githubusercontent.com/14893287/210462690-31aa7bf5-dd79-4e8f-a3c5-1213e73771c4.png"> which has the following href ```code <a href="/just-the-docs/just-the-docs/CHANGELOG/">the CHANGELOG</a> ``` duplicates the `baseurl` twice. There are 14 such broken links across the site. Each link duplicates the `baseurl` and `link` tags, which has since been resolved with links being relative by default (there's a set of PRs that document this - I can't find the exact paper trail right now). To resolve this, I: - find and replace site-wide `{{ site.baseurl }}{% link` with `{% link` - tested each link, which now works properly locally *and* on the deploy preview I'm surprised we didn't catch this earlier! I also could be missing something else, in which case feedback on this PR is certainly welcome.
115 lines
3.5 KiB
Markdown
115 lines
3.5 KiB
Markdown
---
|
|
layout: default
|
|
title: Typography
|
|
parent: UI Components
|
|
nav_order: 1
|
|
---
|
|
|
|
# Typography
|
|
{: .no_toc }
|
|
|
|
## Table of contents
|
|
{: .no_toc .text-delta }
|
|
|
|
1. TOC
|
|
{:toc}
|
|
|
|
---
|
|
|
|
## Font stack
|
|
|
|
By default, Just the Docs uses a native system font stack for sans-serif fonts:
|
|
|
|
```scss
|
|
system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif
|
|
```
|
|
|
|
ABCDEFGHIJKLMNOPQRSTUVWXYZ
|
|
abcdefghijklmnopqrstuvwxyz
|
|
{: .fs-5 .ls-10 .code-example }
|
|
|
|
For monospace type, like code snippets or the `<pre>` element, Just the Docs uses a native system font stack for monospace fonts:
|
|
|
|
```scss
|
|
"SFMono-Regular", Menlo, Consolas, Monospace
|
|
```
|
|
|
|
ABCDEFGHIJKLMNOPQRSTUVWXYZ
|
|
abcdefghijklmnopqrstuvwxyz
|
|
{: .fs-5 .ls-10 .text-mono .code-example }
|
|
|
|
---
|
|
|
|
## Responsive type scale
|
|
|
|
Just the Docs uses a responsive type scale that shifts depending on the viewport size.
|
|
|
|
| Selector | Small screen size `font-size` | Large screen size `font-size` |
|
|
|:----------------------|:---------------------------------|:------------------------------|
|
|
| `h1`, `.text-alpha` | 32px | 36px |
|
|
| `h2`, `.text-beta` | 18px | 24px |
|
|
| `h3`, `.text-gamma` | 16px | 18px |
|
|
| `h4`, `.text-delta` | 14px | 16px |
|
|
| `h5`, `.text-epsilon` | 16px | 18px |
|
|
| `h6`, `.text-zeta` | 18px | 24px |
|
|
| `body` | 14px | 16px |
|
|
|
|
---
|
|
|
|
## Headings
|
|
|
|
Headings are rendered like this:
|
|
|
|
<div class="code-example">
|
|
<h1>Heading 1</h1>
|
|
<h2>Heading 2</h2>
|
|
<h3>Heading 3</h3>
|
|
<h4>Heading 4</h4>
|
|
<h5>Heading 5</h5>
|
|
<h6>Heading 6</h6>
|
|
</div>
|
|
```markdown
|
|
# Heading 1
|
|
## Heading 2
|
|
### Heading 3
|
|
#### Heading 4
|
|
##### Heading 5
|
|
###### Heading 6
|
|
```
|
|
|
|
---
|
|
|
|
## Body text
|
|
|
|
Default body text is rendered like this:
|
|
|
|
<div class="code-example" markdown="1">
|
|
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
|
|
</div>
|
|
```markdown
|
|
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
|
|
```
|
|
|
|
---
|
|
|
|
## Inline elements
|
|
|
|
<div class="code-example" markdown="1">
|
|
Text can be **bold**, _italic_, or ~~strikethrough~~.
|
|
|
|
[Link to another page](another-page).
|
|
</div>
|
|
```markdown
|
|
Text can be **bold**, _italic_, or ~~strikethrough~~.
|
|
|
|
[Link to another page](another-page).
|
|
```
|
|
|
|
---
|
|
|
|
## Typographic Utilities
|
|
|
|
There are a number of specific typographic CSS classes that allow you to override default styling for font size, font weight, line height, and capitalization.
|
|
|
|
[View typography utilities]({% link docs/utilities/typography.md %}){: .btn .btn-outline }
|