Skip to content

Commit 87eb6e4

Browse files
committed
docs: cleanup
1 parent 8b3a76f commit 87eb6e4

File tree

6 files changed

+24
-24
lines changed

6 files changed

+24
-24
lines changed

posts/api-token.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Common examples:
1616
## Usage
1717

1818
1. SSH into our [pico TUI](/ui#ssh-tui)
19-
2. Select "tokens" submenu
20-
3. Type <kbd>c</kbd> to generate a new token
21-
4. Give it a descriptive name
22-
5. Copy the generated token string to where you want to use it
19+
1. Select "tokens" submenu
20+
1. Type <kbd>c</kbd> to generate a new token
21+
1. Give it a descriptive name
22+
1. Copy the generated token string to where you want to use it

posts/custom-domains.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ it works is you create two DNS records:
1111
1. A `CNAME` record to send the traffic to us (or an `A`/`AAAA` if you don't
1212
have
1313
[CNAME flattening](https://developers.cloudflare.com/dns/cname-flattening/))
14-
2. A corresponding `TXT` record which we check to determine what content to
14+
1. A corresponding `TXT` record which we check to determine what content to
1515
serve the user.
1616

1717
The first time we receive traffic on the custom domain, a certificate will be

posts/pgs.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -309,7 +309,7 @@ erock-kittens
309309
We have a couple of special files, when uploaded, will change the behavior of
310310
your site.
311311
312-
## _pgs_ignore
312+
## \_pgs_ignore
313313
314314
You can upload any file you want to pages, with a few exceptions.
315315
@@ -338,7 +338,7 @@ with any comment:
338338
> first so we recommend uploading it on its own and then upload the rest of your
339339
> site.
340340
341-
## _redirects
341+
## \_redirects
342342
343343
We support custom redirects and rewrites via a special file `_redirects`.
344344
@@ -416,7 +416,7 @@ Here are some examples:
416416
If you’re working with proxies, we recommend only publishing HTTPS URLs for
417417
your visitors to use.
418418
419-
## _headers
419+
## \_headers
420420
421421
We support custom headers via a special file `_headers`.
422422

posts/pipe.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ There can be many publishers and many subscribers on a topic. Further, both pub
1313
and sub will wait for at least one event to be sent or received on the topic.
1414

1515
[pipe](https://pipe.pico.sh) is a simple and secure way of putting together
16-
composable directional streams of data, just like a *nix `|` operator!
16+
composable directional streams of data, just like a \*nix `|` operator!
1717

1818
# Features
1919

@@ -40,7 +40,7 @@ composable directional streams of data, just like a *nix `|` operator!
4040

4141
# Examples
4242

43-
For example, maybe you have a *nix pipe you're using on the command line like
43+
For example, maybe you have a \*nix pipe you're using on the command line like
4444
so:
4545

4646
```bash
@@ -143,7 +143,7 @@ Usage: sub <topic> [args...]
143143
Args:
144144
-a string
145145
Comma separated list of pico usernames or ssh-key fingerprints to allow access to a topic
146-
-c Don't send status messages
146+
-c Don\'t send status messages
147147
-k Keep the subscription alive even after the publisher has died
148148
-p Subscribe to a public topic
149149
```
@@ -157,7 +157,7 @@ Args:
157157
-a string
158158
Comma separated list of pico usernames or ssh-key fingerprints to allow access to a topic
159159
-b Block writes until a subscriber is available (default true)
160-
-c Don't send status messages
160+
-c Don\'t send status messages
161161
-e Send an empty message to subs
162162
-p Publish message to public topic
163163
-t duration
@@ -172,7 +172,7 @@ Usage: pipe <topic> [args...]
172172
Args:
173173
-a string
174174
Comma separated list of pico usernames or ssh-key fingerprints to allow access to a topic
175-
-c Don't send status messages
175+
-c Don\'t send status messages
176176
-p Pipe to a public topic
177177
-r Replay messages to the client that sent it
178178
```

posts/prose.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ and try to upload them to prose, the second post will overwrite the first one.
113113

114114
User can change the look-and-feel of their blog by uploading special files.
115115

116-
## _readme.md
116+
## \_readme.md
117117

118118
This file will allow users to add content above the blog post list, add links to
119119
their blog landing page, and change blog metadata.
@@ -179,10 +179,10 @@ This property changes the layout of the blog index page. The options are:
179179
### `with_styles`
180180

181181
This determines whether we load our default styles onto your blog or not. This
182-
allows for better customization in conjunction with [_styles.css](/#-stylescss)
182+
allows for better customization in conjunction with [\_styles.css](/#-stylescss)
183183
which is the user-defined CSS stylesheet that gets served.
184184

185-
## _styles.css
185+
## \_styles.css
186186

187187
This will allow users to change the look-and-feel of their blog. This file will
188188
be the final CSS loaded on the page so it will overwrite whatever styles have
@@ -212,15 +212,15 @@ a file called `barrel.md` then the body element will have:
212212
<body id="post" class="barrel"></body>
213213
```
214214

215-
## _footer.md
215+
## \_footer.md
216216

217217
This file will be added to the end of every single blog post.
218218

219219
There is nothing that differentiates itself from the rest of the post so it's up
220220
to you to style it. For convenience we added an `id` to the containing element
221221
`post-footer`.
222222

223-
## _404.md
223+
## \_404.md
224224

225225
This file will override the default 404 page when a post cannot be found.
226226

posts/tuns.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -292,7 +292,7 @@ and a `tun` interface. To get started, you need to follow a few steps:
292292
socat -v PIPE udp-recvfrom:5553,fork
293293
```
294294
295-
2. SSH into tuns requesting a `tun` interface with the information of where the
295+
1. SSH into tuns requesting a `tun` interface with the information of where the
296296
service is running. This needs to be done as root. Replace
297297
`local-ip-of-machines-main-interface` with the ip address of the main
298298
interface for proper routing.
@@ -302,14 +302,14 @@ and a `tun` interface. To get started, you need to follow a few steps:
302302
udp-forward=10000:local-ip-of-machines-main-interface:5553
303303
```
304304
305-
3. Bring the tunnel interface up and assign an ip that is link local (also as
305+
1. Bring the tunnel interface up and assign an ip that is link local (also as
306306
root):
307307
308308
```bash
309309
ip link set tun0 up; ip r a 10.1.0.1 dev tun0
310310
```
311311
312-
4. Start a udp client to tuns.sh:10000. Here's one with netcat:
312+
1. Start a udp client to tuns.sh:10000. Here's one with netcat:
313313
314314
```bash
315315
nc -u tuns.sh 10000
@@ -330,7 +330,7 @@ make this work! The `SRC` interface `MAC` is `00:00:00:00:00:01`, while the
330330
socat -v PIPE udp-recvfrom:5553,fork
331331
```
332332
333-
2. SSH into tuns requesting a `tap` interface with the information of where the
333+
1. SSH into tuns requesting a `tap` interface with the information of where the
334334
service is running. This needs to be done as root. Replace
335335
`local-ip-of-machines-main-interface` with the ip address of the main
336336
interface for proper routing.
@@ -340,7 +340,7 @@ make this work! The `SRC` interface `MAC` is `00:00:00:00:00:01`, while the
340340
udp-forward=10000:local-ip-of-machines-main-interface:5553
341341
```
342342
343-
3. Bring the tunnel interface up and assign an ip that is link local (also as
343+
1. Bring the tunnel interface up and assign an ip that is link local (also as
344344
root). You need to set the ARP entry and interface `MAC` as well:
345345
346346
```bash
@@ -350,7 +350,7 @@ make this work! The `SRC` interface `MAC` is `00:00:00:00:00:01`, while the
350350
ip neigh add 10.1.0.1 lladdr 00:00:00:00:00:01 dev tap0 nud permanent
351351
```
352352
353-
4. Start a udp client to tuns.sh:10000. Here's one with netcat:
353+
1. Start a udp client to tuns.sh:10000. Here's one with netcat:
354354
355355
```bash
356356
nc -u tuns.sh 10000

0 commit comments

Comments
 (0)