You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ Henceforth:
15
15
* Run `site` to build the website and spin up a live-reloading dev server.
16
16
* Run `site help` to see other available commands.
17
17
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`)
19
19
20
20
<br><br>
21
21
@@ -101,7 +101,7 @@ template: landing
101
101
All the fanciness of the build system is *opt-in*. Frontmatter is the primary way for a page to opt-in to special processing.
102
102
103
103
* 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.
105
105
106
106
#### Template
107
107
@@ -121,7 +121,7 @@ If a page is given a `date`, it'll be included in RSS feeds. The date must be in
121
121
122
122
#### Others
123
123
124
-
*`title` will be used for <title> and for RSS.
124
+
*`title` will be used for `<title>` and for RSS.
125
125
*`description` will be used for OG and RSS. Can include inline markdown.
126
126
*`image` for the rich preview whenever someone shares a link to the page.
127
127
*`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
168
168
169
169
### Assets
170
170
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:
172
172
173
173
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).
174
174
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
182
182
183
183
Instead, to add fonts to our website, you place `ttf` or `otf` files in the `/fonts` folder. The build system can then:
184
184
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.
186
186
2. Create a **subset** of data in the `ttf` / `otf` files with just the characters we use.
187
187
3. Create optimized `woff2` files of those subset fonts, and save them to `/content/static/fonts/`.
188
188
@@ -241,7 +241,7 @@ The website includes the `site` CLI tool.
241
241
242
242
You can run `site help` to list all the available commands.
243
243
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`)
245
245
246
246
`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).
0 commit comments