Skip to content

docs: add CDN hosting instructions and improve usage examples #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 18, 2025
Merged

docs: add CDN hosting instructions and improve usage examples #26

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eca5bed
feat: add a "CDN Hosted" section
caidanw Jun 18, 2025
e0159fd
feat: add "Using the Font" section
caidanw Jun 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 43 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ brew install --cask font-server-mono

## Usage

### Self Hosted

Add the downloaded font files to your website's public/static directory. The examples below use a `/fonts/` prefix, but you can adjust this path to match your project structure.

Copy the below snippet into your CSS file:
Expand All @@ -46,14 +48,54 @@ Copy the below snippet into your CSS file:
font-style: oblique;
font-display: swap;
}
```

### CDN Hosted

ServerMono is also available through the [jsDelivr CDN](https://cdn.jsdelivr.net/gh/internet-development/www-server-mono/public/fonts/), so that you can use the fonts with downloading and hosting them yourself.

Copy the below snippet into your CSS file:

```css
/* Regular weight - used for normal text */
@font-face {
font-family: 'ServerMono';
src: url('https://cdn.jsdelivr.net/gh/internet-development/www-server-mono/public/fonts/ServerMono-Regular.woff2') format('woff2'), /* Best compression, modern browsers */
url('https://cdn.jsdelivr.net/gh/internet-development/www-server-mono/public/fonts/ServerMono-Regular.woff') format('woff'), /* Good compression, wider support */
url('https://cdn.jsdelivr.net/gh/internet-development/www-server-mono/public/fonts/ServerMono-Regular.otf') format('opentype'); /* Largest files, universal support */
font-weight: normal;
font-style: normal;
font-display: swap;
}

/* Slanted variant - used for italic/oblique text */
@font-face {
font-family: 'ServerMono';
src: url('https://cdn.jsdelivr.net/gh/internet-development/www-server-mono/public/fonts/ServerMono-RegularSlanted.woff2') format('woff2'),
url('https://cdn.jsdelivr.net/gh/internet-development/www-server-mono/public/fonts/ServerMono-RegularSlanted.woff') format('woff'),
url('https://cdn.jsdelivr.net/gh/internet-development/www-server-mono/public/fonts/ServerMono-RegularSlanted.otf') format('opentype');
font-weight: normal;
font-style: oblique;
font-display: swap;
}
```

### Using the Font

Then you can use it across your entire site like so:

```css
:root {
font-family: 'ServerMono', monospace;
font-family: 'ServerMono', monospace;
}
```

To use the slanted version, set the font style to either `oblique` or `italic`:

```css
p {
font-family: 'ServerMono', monospace;
font-style: 'oblique';
}
```

Expand Down