Browse Source

docs(help/features): fix linkrot & do wordsmithing

Josh Habdas 2 years ago
parent
commit
4fb9f6f24c
Signed by: Josh Habdas <jhabdas@protonmail.com> GPG Key ID: B148B31154C75A74

+ 1
- 1
docs/content/feature/air-gapping.md View File

@@ -13,7 +13,7 @@ Unless running the [Quick Installer](../quick-installer) After Dark does not req
13 13
 - Run your site behind a NAT or firewall blocking all outbound requests.
14 14
 - Review the [Online Help](../online-help) docs during a flight on Virgin Galactic.
15 15
 - Report local news from West Timor without tipping off the authorities.
16
-- Create a [PhotoSwipe Gallery](modules/hall-of-mirrors) while trekking the Mount Nimbus via ferrata.
16
+- Create a [PhotoSwipe Gallery](module/hall-of-mirrors) while trekking the Mount Nimbus via ferrata.
17 17
 - Document the Syrian Civil War without revealing activity to ISPs.
18 18
 
19 19
 By default After Dark makes no outbound requests **except** when viewing non-essential [Online Help](../online-help) and where appropriate to cover related functionality.

+ 5
- 5
docs/content/feature/fetch-injection.md View File

@@ -3,10 +3,12 @@ title = "Fetch Injection"
3 3
 description = "Load external scripts and styles with incredible speed."
4 4
 categories = ["experience"]
5 5
 tags = ["performance", "styles"]
6
-features = ["snippets", "related content"]
6
+features = ["snippets", "related content", "code highlighter"]
7 7
 +++
8 8
 
9
-After Dark uses {{< external rel="external help" href="https://git.habd.as/jhabdas/fetch-inject" text="Fetch Inject" />}} library to load and execute external scripts and styles faster than browsers are natively capable of themselves.
9
+After Dark uses the {{< external rel="external help" href="https://git.habd.as/jhabdas/fetch-inject" text="Fetch Inject" />}} library to load and execute external scripts and styles faster than browsers are natively capable of themselves.
10
+
11
+{{< external href="https://hackcabin.com/post/managing-async-dependencies-javascript/" text="Fetch Injection" />}} was conceptualized and first developed specifically for After Dark to make it possible to deep-link to full-sized [PhotoSwipe  Gallery](/module/hall-of-mirrors) images near-instantly and some other useful performance applications:
10 12
 
11 13
 <table>
12 14
   <thead>
@@ -26,8 +28,6 @@ After Dark uses {{< external rel="external help" href="https://git.habd.as/jhabd
26 28
   </tbody>
27 29
 </table>
28 30
 
29
-{{< external href="https://hackcabin.com/post/managing-async-dependencies-javascript/" text="Fetch Injection" />}} was conceptualized and first developed specifically for After Dark to make it possible to deep-link to full-sized [Image Gallery](/module/hall-of-mirrors) images near-instantly and carries with it a number of other performance applications.
30
-
31 31
 Use Fetch Inject in your [Custom Layouts](../custom-layouts) to load scripts and styles from your site `static` directory or include cross-origin resources:
32 32
 
33 33
 {{< highlight html "linenos=inline" >}}
@@ -38,4 +38,4 @@ Use Fetch Inject in your [Custom Layouts](../custom-layouts) to load scripts and
38 38
 </script>
39 39
 {{< /highlight >}}
40 40
 
41
-Fetch Inject is non-blocking, has 0 dependencies and is already included for use on all pages within After Dark. See the {{< external rel="external help" href="https://git.habd.as/jhabdas/fetch-inject" text="Fetch Inject" />}} `README` for use cases.
41
+Fetch Inject is non-blocking, has 0 dependencies and is already included for use on all pages within After Dark. See {{< external rel="external help" href="https://git.habd.as/jhabdas/fetch-inject" text="Fetch Inject" />}} for additional use cases.

+ 4
- 4
docs/content/feature/jit-requests.md View File

@@ -14,7 +14,7 @@ Take the [Code Highlighter](../code-highlighter) stylesheet for example:
14 14
 {{< include "themes/after-dark/static/css/syntax.css" >}}
15 15
 {{< /highlight >}}
16 16
 
17
-The above highlighted code is, itself, highlighted using a JIT request. Confirm by viewing the network requests for this page and observe the `fetch` requests:
17
+The stylesheet code shown above is itself highlighted using a JIT request. Confirm by viewing the network requests for this page and observe the `fetch` request for the `syntax.css` file as depicted here:
18 18
 
19 19
 ```sh
20 20
 jit-requests (document)
@@ -22,8 +22,8 @@ jit-requests (document)
22 22
 ├── syntax.css (fetch)
23 23
 ```
24 24
 
25
-Rather than blocking the page with an external request [Fetch Injection](../fetch-injection) is used to load them on-the-fly while the base layout takes care to ensure they're only on pages which actually need them.
25
+Using [Fetch Injection](../fetch-injection) a JIT request is issued to begin downloading the highlighter stylesheet on-the-fly in parallel with other resources and the base layout takes care to ensure the CSS is only requested on pages that need it.
26 26
 
27
-Another example can be seen in the [Table Of Contents](../table-of-contents) whereby a {{< external href="https://devdocs.io/css/scroll-behavior" text="scroll-behavior" />}} polyfill is loaded but not until user shows intent to use the feature.
27
+Another example of a JIT request can be seen in the [Table Of Contents](../table-of-contents) whereby a `scroll-behavior` polyfill is loaded asynchronyously and only once the user shows intent to use the feature, otherwise hidden under a disclosure.
28 28
 
29
-Study these patterns and try building your own in your own [Custom Layouts](../custom-layouts).
29
+Create your own JIT requests using [Custom Layout](../custom-layouts) and [Fetch Injection](../fetch-injection).

Loading…
Cancel
Save