Skip to content

Commit c708fb5

Browse files
committed
Cleanup some README typos / issues
1 parent dd10979 commit c708fb5

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Henceforth:
1515
* Run `site` to build the website and spin up a live-reloading dev server.
1616
* Run `site help` to see other available commands.
1717

18-
> If `site` doesn't work, use `./site` instead (or add `.` to your $PATH)
18+
> If `site` doesn't work, use `./site` instead (or add `.` to your `$PATH`)
1919
2020
<br><br>
2121

@@ -101,7 +101,7 @@ template: landing
101101
All the fanciness of the build system is *opt-in*. Frontmatter is the primary way for a page to opt-in to special processing.
102102

103103
* For an HTML file with no frontmatter, no processing is applied (including the aforementioned [clean-URL renaming](#clean-urls)).
104-
* All markdown files in `/content` get processing special whether they have frontmatter or not.
104+
* All markdown files in `/content` get special processing whether they have frontmatter or not.
105105

106106
#### Template
107107

@@ -121,7 +121,7 @@ If a page is given a `date`, it'll be included in RSS feeds. The date must be in
121121

122122
#### Others
123123

124-
* `title` will be used for <title> and for RSS.
124+
* `title` will be used for `<title>` and for RSS.
125125
* `description` will be used for OG and RSS. Can include inline markdown.
126126
* `image` for the rich preview whenever someone shares a link to the page.
127127
* `styles` and `scripts`, which accept comma-separated lists of relative or absolute paths.
@@ -168,7 +168,7 @@ For instance, the Automerge logo lives in `/template/includes/logo.html`, and ca
168168

169169
### Assets
170170

171-
Git is *fine* for version control of text. It's *awful* for images and videos — it remembers ever version of every asset that's ever been committed, and they slow down clones, diff, and other actions. Before adding images, videos, and other non-text assets to the repo, please do the following:
171+
Git is *fine* for version control of text. It's *awful* for images and videos — they slow down clones, diff, and other actions. Before you commit images, videos, and other non-text assets to the repo, please do the following:
172172

173173
1. **Resize** — if an image is only going to display at 1000px wide (at most), it should be no more than 2000px wide, and ideally closer to 1200px. (A tiny bit of extra detail is often enough to give the illusion of a crisp 2x retina image).
174174
2. **Format** — line art and screenshots should be PNG or WebP, photos should be WebP or JPG.
@@ -182,7 +182,7 @@ In typical web development, you'd put a `woff2` font file alongside your other a
182182

183183
Instead, to add fonts to our website, you place `ttf` or `otf` files in the `/fonts` folder. The build system can then:
184184

185-
1. Scan every page of the site, and collect every unique character of text.
185+
1. Scan every page of the site and collect every unique character of text.
186186
2. Create a **subset** of data in the `ttf` / `otf` files with just the characters we use.
187187
3. Create optimized `woff2` files of those subset fonts, and save them to `/content/static/fonts/`.
188188

@@ -241,7 +241,7 @@ The website includes the `site` CLI tool.
241241

242242
You can run `site help` to list all the available commands.
243243

244-
> If `site` doesn't work, use `./site` instead (or better yet, add `.` to your $PATH)
244+
> If `site` doesn't work, use `./site` instead (or better yet, add `.` to your `$PATH`)
245245
246246
`site` is a little shell script at the root of the repo. It executes `system/app.ts` using the fastest available Node-compatible runtime (bun, deno, or node).
247247

0 commit comments

Comments
 (0)