Browse Source

docs(feature/quick-install): incorporate user feedback and simplify instructions

closes #152
Josh Habdas 1 month ago
parent
commit
ac74c82071
Signed by: Josh Habdas <jhabdas@protonmail.com> GPG Key ID: B148B31154C75A74

+ 14
- 12
README.md View File

@@ -18,23 +18,23 @@
18 18
 wget -qO - https://go.habd.as/after-dark | sh
19 19
 ```
20 20
 
21
-**After Dark** is an extensible, offline-first [Hugo](https://gohugo.io) theme written from the ground up for speed, privacy and security.
21
+**After Dark** is an extensible, robust [Hugo](https://gohugo.io) theme written from the ground up for speed, privacy and security.
22 22
 
23 23
 ## Features
24 24
 
25 25
 - **[Streamlined Workflow](https://after-dark.habd.as/#feature-workflow)**: Cross-platform, 1 dependency, single-codebase.
26
+- **[Easily Customized](https://after-dark.habd.as/#feature-customize)**: Easily modify website look-and-feel.
26 27
 - **[Unparalleled Speed](https://after-dark.habd.as/#feature-speed)**: ~0.615s builds and decisecond page loads.
27
-- **[Advanced Graphics](https://after-dark.habd.as/#feature-graphics)**: Responsive post images with LQIP.
28
-- **[Rewards System](https://after-dark.habd.as/#feature-rewards)**: Monetize attention and earn a borderless income.
28
+- **[Advanced Graphics](https://after-dark.habd.as/#feature-graphics)**: Responsive post and thumbnail images.
29 29
 - **[Fuzzy Search](https://after-dark.habd.as/#feature-search)**: Offline, automatic and no third-parties.
30
-- **[Easily Customized](https://after-dark.habd.as/#feature-customize)**: Change skins, strip styles, modify layouts.
30
+- **[Rewards System](https://after-dark.habd.as/#feature-rewards)**: Monetize attention and earn a borderless income.
31 31
 - **[Securely Designed](https://after-dark.habd.as/#feature-security)**: CSP, Referrer Policy, Release Hashes
32 32
 - **[Privacy Focused](https://after-dark.habd.as/#feature-privacy)**: No cookies, no external requests, ephemeral hosting.
33 33
 - **[Batteries Included](https://after-dark.habd.as/#feature-extras)**: Self-host with gitea, k3s, traefik and fathom.
34 34
 
35 35
 ## Demo
36 36
 
37
-Click a screenshot to view a live demo of the functionality.
37
+Click a screenshot for a live demo of the functionality:
38 38
 
39 39
 <table>
40 40
   <tr>
@@ -88,24 +88,24 @@ Click a screenshot to view a live demo of the functionality.
88 88
 
89 89
 ## Getting Started
90 90
 
91
-Unless you're starting with [After Dark K3s](https://after-dark.habd.as/extra/after-dark-k3s) please [Install Hugo](https://gohugo.io/getting-started/installing) `0.44` or greater on your machine prior to installation.
91
+Please [Install Hugo](https://gohugo.io/getting-started/installing) `0.44` or greater on your machine prior to installation unless you're starting with [After Dark K3s](https://after-dark.habd.as/extra/after-dark-k3s).
92 92
 
93 93
 ### Installation
94 94
 
95
-For scripted installation use the provided [Quick Install](https://after-dark.habd.as/feature/quick-install/) script. Quick Install is ideal for first-time users and does not require use of git. Use it to automatically set-up, configure and run a sample After Dark website you may re-purpose as your own.
95
+For fastest installation use the provided [Quick Install](https://after-dark.habd.as/feature/quick-install/) script. Quick Install is ideal for first-time users and does not require use of git. Use it to automatically set-up, configure and run a sample After Dark website you may re-purpose as your own.
96 96
 
97
-By convention After Dark may be used with an existing Hugo site by git cloning to or adding as a submodule:
97
+By convention After Dark may be used with an existing Hugo site by git cloning to or adding as a submodule of the `themes` directory:
98 98
 
99 99
 ```sh
100 100
 flying-toasters
101 101
 ├── static
102 102
 └── themes
103
-    └── after-dark # git clone or add submodule here
103
+    └── after-dark # the clone or submodule
104 104
 ```
105 105
 
106
-See [Install a Single Theme](https://gohugo.io/themes/installing-and-using-themes/#install-a-single-theme) on the Hugo docs site for step-by-step instructions.
106
+See [Install a Single Theme](https://gohugo.io/themes/installing-and-using-themes/#install-a-single-theme) on the Hugo docs site for further instructions.
107 107
 
108
-After Dark also ships [as an NPM module](https://www.npmjs.com/package/after-dark) as a convenience for users. As with git, Node isn't required to install or run After Dark but may be leveraged when integrating with existing publishing workflows.
108
+After Dark also ships [as an NPM module](https://www.npmjs.com/package/after-dark) as a convenience for users. Use it to integrate After Dark into an existing publishing workflow.
109 109
 
110 110
 ### Upgrading
111 111
 
@@ -115,13 +115,15 @@ Run the [Upgrade Script](https://after-dark.habd.as/feature/upgrade-script/) to
115 115
 ./themes/after-dark/bin/upgrade
116 116
 ```
117 117
 
118
+Upgrading replaces the file contents of the theme as a whole.
119
+
118 120
 ### Verifying
119 121
 
120 122
 If installed or upgraded via script you may use the [Release Validator](https://after-dark.habd.as/validate/) to verify you're running a PGP-signed and SHA-verified release. Integrity is checked at the source level and may be performed offline. See [Release Hashes](https://after-dark.habd.as/feature/release-hashes/) for more info.
121 123
 
122 124
 ### Usage
123 125
 
124
-Use the included [Online Help](https://after-dark.habd.as/feature/online-help/) to learn how to set-up and use After Dark. Help docs may be served locally and do not require an Internet connection to function.
126
+Use [Online Help](https://after-dark.habd.as/feature/online-help/) to learn how to set-up and use After Dark. Help docs may be served locally and do not require an Internet connection to function.
125 127
 
126 128
 ## Credits
127 129
 

+ 3
- 3
docs/content/_index.md View File

@@ -23,7 +23,7 @@ images = [
23 23
 
24 24
 <section class="grid tagline">
25 25
   <div class="cell -12of12">
26
-    <p>After Dark is free and open-source software you can use to create a website, blog or app. Utilize the world's fastest framework for building websites to build the <a href="#feature-speed">fastest</a> websites in the world, online or off.</p>
26
+    <p>After Dark is free and open-source software you can use to create a website, blog or app. Utilize the world's fastest framework for building websites to build the fastest websites in the world, online or off.</p>
27 27
   </div>
28 28
 </section>
29 29
 
@@ -98,9 +98,9 @@ images = [
98 98
   <h2>Advanced Graphics</h2>
99 99
   <p>Add high-resolution, responsive images with <strong>low-quality image placeholders</strong> and <strong>engaging visual effects</strong> without even touching an image editor.</p>
100 100
   <nav><p>
101
+    <a href="/feature/custom-homepage/">Thumbnails</a> |
101 102
     <a href="/shortcode/figure/">Figures</a> |
102 103
     <a href="/feature/post-images/">Post Images</a> |
103
-    <a href="/module/hall-of-mirrors/">Galleries</a> |
104 104
     <a href="/module/fractal-forest/">BPG</a>
105 105
   </p></nav>
106 106
 </section>
@@ -114,7 +114,7 @@ images = [
114 114
   <p>Quickly <strong>locate <i>indexed</i> content</strong> anywhere on your site using inbuilt fuzzy search with automatic search indexing and <strong>full offline support</strong>.</p>
115 115
   <nav><p>
116 116
     <a href="/search/?s=lay%20load">Try It Now</a> |
117
-    <a href="/feature/fuzzy-search/">More Detail</a>
117
+    <a href="/feature/fuzzy-search/">How to Use</a>
118 118
   </p></nav>
119 119
 </section>
120 120
 

+ 8
- 17
docs/content/feature/quick-install.id.md View File

@@ -14,10 +14,8 @@ notes = [
14 14
   license = "agpl-3.0-or-later"
15 15
 +++
16 16
 
17
-After Dark termasuk skrip instalasi portabel untuk pengaturan cepat:
17
+After Dark termasuk skrip instalasi portabel untuk pengaturan cepat. Silahkan instal {{< external href="https://gohugo.io" text="Hugo" />}} `0.44` atau yang lebih besar sebelum menjalankan skrip:
18 18
 
19
-{{< hackcss-card header="themes/after-dark/bin/install" >}}
20
-<style>.card-content .inner { overflow: scroll; max-height: 30em; }</style>
21 19
 <details itemscope itemtype="https://schema.org/SoftwareSourceCode">
22 20
 <summary>Perluas untuk melihat skrip</summary>
23 21
 {{< highlight shell "linenos=inline" >}}
@@ -30,17 +28,14 @@ After Dark termasuk skrip instalasi portabel untuk pengaturan cepat:
30 28
 <link itemprop="targetProduct" href="https://after-dark.habd.as">
31 29
 <meta itemprop="accessMode" content="textual">
32 30
 </details>
33
-{{< /hackcss-card >}}
34
-
35
-Silahkan instal {{< external href="https://gohugo.io" text="Hugo" />}} `0.44` atau yang lebih besar sebelum menjalankan skrip.
36 31
 
37 32
 <!--more-->
38 33
 
39
-Skrip telah diuji pada Debian, BusyBox dan Darwin, dan seharusnya juga dapat bekerja di bawah Alpine, Ubuntu, Docker dan Windows melalui {{< external href="http://cmder.net" text="Cmder" />}} tanpa ketergantungan tambahan.
34
+Skrip telah diuji pada GNU/Linux dan BSD (Darwin) dan Windows melalui {{< external href="http://cmder.net" text="Cmder" />}}.
40 35
 
41
-{{% hackcss-alert type="warning" %}}**Warning:** selalu periksa skrip yang diunduh dari internet sebelum menjalankannya secara lokal. Jika anda memilih untuk tidak menjalankan skrip [Unduh secara manual](/#download).{{% /hackcss-alert %}}
36
+{{% hackcss-alert type="warning" %}}**Warning:** Periksa skrip yang diunduh dari Internet sebelum menjalankannya.{{% /hackcss-alert %}}
42 37
 
43
-Jalankan skrip sesuka anda. Berikut adalah metode yang memungkinkan:
38
+Berikut adalah tiga metode untuk men-download dan menjalankan:
44 39
 
45 40
 1. Unduh dan kirim ke `sh` secara langsung:
46 41
 
@@ -48,8 +43,6 @@ Jalankan skrip sesuka anda. Berikut adalah metode yang memungkinkan:
48 43
     {{< highlight shell >}}wget -qO - https://go.habd.as/after-dark | sh{{< /highlight >}}
49 44
     {{< /hackcss-alert >}}
50 45
 
51
-    <i>(Cojones not included.)</i>
52
-
53 46
 2. Unduh di file baru, `chmod` dan jalankan:
54 47
 
55 48
     {{< hackcss-alert >}}
@@ -57,8 +50,6 @@ Jalankan skrip sesuka anda. Berikut adalah metode yang memungkinkan:
57 50
 chmod +x install && ./install{{< /highlight >}}
58 51
     {{< /hackcss-alert >}}
59 52
 
60
-    <i>(It's safe if it comes from a CDN, amirite?)</i>
61
-
62 53
 3. Dari kanonik `git` klon:
63 54
 
64 55
     {{< hackcss-alert >}}
@@ -72,17 +63,17 @@ echo "${$(npm run integrity)#*sha512-}"
72 63
 {{< /highlight >}}
73 64
     {{< /hackcss-alert >}}
74 65
 
75
-    <i>(<a href="/feature/release-hashes/">Release Hashes</a> may be used for code validation.)</i>
76
-
77 66
 Skrip harus selesai dalam 5-10 detik sehingga menghasilkan sampel situs dan dokumen bantuan:
78 67
 
79 68
 {{< figure alt="After Dark screenshots"
80 69
   src="/images/quick-install.png"
81 70
   lqipsrc="/images/quick-install-fs8.png"
82
-  caption="After Dark Quick Install running to completion in Terminal on macOS Mojave."
71
+  caption="After Dark Quick Install running to completion in Terminal on Deepin Manjaro."
83 72
 >}}
84 73
 
85
-# Konfigurasi multi situs
74
+Situs baru Anda akan disebut `flying-toasters`. Ubah ke nama proyek Anda.
75
+
76
+# Konfigurasi Multi-situs (Lanjutan)
86 77
 
87 78
 After Dark memungkingkan menjalankan manajemen multi situs dari satu instalasi. Untuk mengelola beberapa website gunakan `-c` dan `-d` bendera untuk menentukan konten dan tujuan direktori secara berurutan.
88 79
 

+ 8
- 17
docs/content/feature/quick-install.md View File

@@ -17,10 +17,8 @@ aliases = [
17 17
   license = "agpl-3.0-or-later"
18 18
 +++
19 19
 
20
-After Dark includes a portable installation script for quick set-up:
20
+After Dark includes a portable installation script for quick set-up. Please install {{< external href="https://gohugo.io" text="Hugo" />}} `0.44` or greater before running the script:
21 21
 
22
-{{< hackcss-card header="themes/after-dark/bin/install" >}}
23
-<style>.card-content .inner { overflow: scroll; max-height: 30em; }</style>
24 22
 <details itemscope itemtype="https://schema.org/SoftwareSourceCode">
25 23
 <summary>Expand to view script</summary>
26 24
 {{< highlight sh "linenos=inline" >}}
@@ -33,17 +31,14 @@ After Dark includes a portable installation script for quick set-up:
33 31
 <link itemprop="targetProduct" href="https://after-dark.habd.as">
34 32
 <meta itemprop="accessMode" content="textual">
35 33
 </details>
36
-{{< /hackcss-card >}}
37
-
38
-Please install {{< external href="https://gohugo.io" text="Hugo" />}} `0.44` or greater before running the script.
39 34
 
40 35
 <!--more-->
41 36
 
42
-Script has been tested on Debian, BusyBox and Darwin, and should also work under Alpine, Ubuntu, Docker and Windows via {{< external href="http://cmder.net" text="Cmder" />}} without additional dependencies.
37
+Script has been tested on GNU/Linux, BSD (Darwin) and Windows via {{< external href="http://cmder.net" text="Cmder" />}}.
43 38
 
44
-{{% hackcss-alert type="warning" %}}**Warning:** Always examine scripts downloaded from the internet before running them locally. If you'd prefer not to run the script [Download Manually](/#download).{{% /hackcss-alert %}}
39
+{{% hackcss-alert type="warning" %}}**Warning:** Examine scripts downloaded from the Internet before running them.{{% /hackcss-alert %}}
45 40
 
46
-Run the script however you like. Here are three possible methods:
41
+Here are three methods for downloading and running:
47 42
 
48 43
 1. Download and pipe to `sh` directly:
49 44
 
@@ -51,8 +46,6 @@ Run the script however you like. Here are three possible methods:
51 46
     {{< highlight shell >}}wget -qO - https://go.habd.as/after-dark | sh{{< /highlight >}}
52 47
     {{< /hackcss-alert >}}
53 48
 
54
-    <i>(Cojones not included.)</i>
55
-
56 49
 2. Download into new file, `chmod` and execute:
57 50
 
58 51
     {{< hackcss-alert >}}
@@ -60,8 +53,6 @@ Run the script however you like. Here are three possible methods:
60 53
 chmod +x install && ./install{{< /highlight >}}
61 54
     {{< /hackcss-alert >}}
62 55
 
63
-    <i>(It's safe if it comes from a CDN, amirite?)</i>
64
-
65 56
 3. From canonical `git` clone:
66 57
 
67 58
     {{< hackcss-alert >}}
@@ -76,17 +67,17 @@ echo "${$(npm run integrity)#*sha512-}"
76 67
 {{< /highlight >}}
77 68
     {{< /hackcss-alert >}}
78 69
 
79
-    <i>(<a href="/feature/release-hashes/">Release Hashes</a> may be used for code validation.)</i>
80
-
81 70
 Script should complete in 5-10 seconds resulting in a sample site and help docs:
82 71
 
83 72
 {{< figure alt="After Dark screenshots"
84 73
   src="/images/quick-install.png"
85 74
   lqipsrc="/images/quick-install-fs8.png"
86
-  caption="After Dark Quick Install running to completion in Terminal on macOS Mojave."
75
+  caption="After Dark Quick Install running to completion in Terminal on Deepin Manjaro."
87 76
 >}}
88 77
 
89
-# Multi-site Configuration
78
+Your new site will be called `flying-toasters`. Change it to the name of your project.
79
+
80
+# Multi-site Configuration (Advanced)
90 81
 
91 82
 After Dark enables multi-site management from a single installation. To manage multiple websites use the `-c` and `-d` flags to specify the `content` and `destination` directories, respectively
92 83
 

BIN
docs/static/images/quick-install-fs8.png View File


BIN
docs/static/images/quick-install.png View File


Loading…
Cancel
Save