Browse Source

docs(help/onboarding): rename quick installer and improve usability

Josh Habdas 8 months ago
parent
commit
ba41338904
Signed by: Josh Habdas <jhabdas@protonmail.com> GPG Key ID: B148B31154C75A74

+ 13
- 21
README.md View File

@@ -1,6 +1,6 @@
1 1
 # After Dark
2 2
 
3
-> After Dark is an extensible flat-file CMS built on Hugo designed to create incredibly fast static websites which are easy to learn, rewarding to build, simple to maintain and securely designed.
3
+> After Dark is a self-hosted flat-file CMS built on Hugo designed to create static websites ungodly fast.
4 4
 
5 5
 [![Latest NPM version](https://img.shields.io/npm/v/after-dark.svg?style=flat-square)](https://www.npmjs.com/package/after-dark)
6 6
 [![Monthly downloads](https://img.shields.io/npm/dm/after-dark.svg?style=flat-square)](https://www.npmjs.com/package/after-dark)
@@ -11,16 +11,14 @@
11 11
 
12 12
 ## Features
13 13
 
14
-Here are a few highlights of what's included:
14
+- [Web Mining](https://after-dark.habd.as/#feature-mining)
15
+- [Unreal Graphics](https://after-dark.habd.as/#feature-graphics)
16
+- [Ludicrous Speed](https://after-dark.habd.as/#feature-speed)
17
+- [Fully Customizable](https://after-dark.habd.as/#feature-customize)
18
+- [Offline Search](https://after-dark.habd.as/#feature-search)
19
+- [Securely Designed](https://after-dark.habd.as/#feature-security)
15 20
 
16
-- Create lazy-loading responsive images and galleries without touching an image editor.
17
-- Load entire pages in less than half a second without relying on complex build systems.
18
-- Locate indexable content anywhere on your site even without an Internet connection.
19
-- Toggle between 1 of 8 customizable skin styles or disable entirely and roll your own.
20
-- Earn incentives for staying up-to-date and reward your creativity as you work.
21
-- Validate the integrity of your codebase using secure cryptographic release hashes.
22
-
23
-Visit [after-dark.habd.as](https://after-dark.habd.as) for demo, docs and more detail.
21
+And a lot more. Visit [after-dark.habd.as](https://after-dark.habd.as) to get a feel for what's possible.
24 22
 
25 23
 ## Screenshots
26 24
 
@@ -76,22 +74,16 @@ Visit [after-dark.habd.as](https://after-dark.habd.as) for demo, docs and more d
76 74
 
77 75
 ## Getting Started
78 76
 
79
-[Install Hugo](https://gohugo.io/getting-started/installing) before getting started.
77
+Please [Install Hugo](https://gohugo.io/getting-started/installing) `0.44` or greater before getting started.
80 78
 
81 79
 ### Installation
82 80
 
83
-Use [Quick Installer](https://after-dark.habd.as/feature/quick-installer/) to start a new site:
81
+For scripted installation please use [Quick Install](https://after-dark.habd.as/feature/quick-install/). Otherwise download a copy and:
84 82
 
85
-```shell
86
-wget -qO - https://go.habd.as/after-dark | sh
83
+```sh
84
+hugo serve --theme after-dark
87 85
 ```
88 86
 
89
-Scripted installation should complete in 5-10 seconds depending on connection speed:
90
-
91
-<a href="https://asciinema.org/a/E1Ds7jbjhTel52PvMqZzuGsWE" target="_blank"><img src="https://asciinema.org/a/E1Ds7jbjhTel52PvMqZzuGsWE.png" alt="Quick Installer screenshot"></a>
92
-
93
-Manual installation possible via `git clone` or by simply downloading one of the [available releases](https://git.habd.as/comfusion/after-dark/releases) to the themes directory of an existing hugo site and then serve the site with `hugo serve --theme after-dark`. Each release includes an example website in the `/docs` directory to help you get started.
94
-
95 87
 ### Upgrading
96 88
 
97 89
 Run the [Upgrade Script](https://after-dark.habd.as/feature/upgrade-script/) anytime to check for updates and automatically upgrade to the latest version.
@@ -102,7 +94,7 @@ If installed or upgraded via script you may use the [Release Validator](https://
102 94
 
103 95
 ### Help
104 96
 
105
-Complete [Online Help](https://after-dark.habd.as/feature/online-help/) documentation included with installation.
97
+Complete [Online Help](https://after-dark.habd.as/feature/online-help/) included in the `/docs` directory.
106 98
 
107 99
 ## License
108 100
 

+ 1
- 1
archetypes/post.md View File

@@ -53,7 +53,7 @@ The [Module System](http://localhost:1414/feature/module-system/), for example,
53 53
 
54 54
 ![BPG animation example](/bpg/cinemagraph-6.bpg)
55 55
 
56
-If you do not see the above animation, you may install the [Fractal Forest](http://localhost:1414/module/fractal-forest/) module yourself or reinstall After Dark using the [Quick Installer](http://localhost:1414/feature/quick-installer/) for instant setup.
56
+If you do not see the above animation, you may install the [Fractal Forest](http://localhost:1414/module/fractal-forest/) module yourself or reinstall After Dark using the [Quick Install](http://localhost:1414/feature/quick-install/) for instant setup.
57 57
 
58 58
 Review the [Online Help](http://localhost:1414/) to learn about other useful features such as the [Section Menus](http://localhost:1414/feature/section-menu) navigational aid, responsive [Post Images](http://localhost:1414/feature/post-images/"), offline [Fuzzy Search](http://localhost:1414/feature/fuzzy-search/) and more.
59 59
 

+ 1
- 1
docs/archetypes/validate.md View File

@@ -25,7 +25,7 @@ noindex = true
25 25
   {{< /hackcss-formgroup >}}
26 26
 {{< /hackcss-form >}}
27 27
 
28
-<small>Valid installations use the [Quick Installer](/feature/quick-installer) or [Upgrade Script](/feature/upgrade-script) and may be checked offline. See [Release Hashes](/feature/release-hashes) for a more thorough approach to validation.</small>
28
+<small>Valid installations use the [Quick Install](/feature/quick-install) or [Upgrade Script](/feature/upgrade-script) and may be checked offline. See [Release Hashes](/feature/release-hashes) for a more thorough approach to validation.</small>
29 29
 
30 30
 <script>
31 31
   (function (window, document, undefined) {

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

@@ -1,6 +1,6 @@
1 1
 +++
2 2
 title = "After Dark"
3
-description = "After Dark is an extensible flat-file CMS built on Hugo designed to create incredibly fast static websites."
3
+description = "After Dark is a self-hosted flat-file CMS built on Hugo designed to create static websites ungodly fast."
4 4
 images = [
5 5
   "https://after-dark.habd.as/images/screenshots/example-landing-page-fs8.png"
6 6
 ]
@@ -17,7 +17,7 @@ images = [
17 17
 
18 18
 <section class="grid tagline">
19 19
   <div class="cell -12of12">
20
-    <p>After Dark is an extensible flat-file CMS built on Hugo designed to create incredibly fast static websites which are easy to learn, rewarding to build, simple to maintain and securely designed.</p>
20
+    <p>After Dark is a self-hosted flat-file CMS built on Hugo designed to create static websites ungodly fast.</p>
21 21
   </div>
22 22
 </section>
23 23
 
@@ -44,11 +44,11 @@ images = [
44 44
       stroke: #ff9800;
45 45
     }
46 46
   </style>
47
-  {{< external rel="noopener" target="_self" href="/feature/quick-installer" >}}
47
+  {{< external rel="noopener" target="_self" href="/feature/quick-install" >}}
48 48
     {{< hackcss-button type="primary" isghost="true" >}}
49 49
       <svg class="i-download" viewBox="0 0 32 32" width="24" height="24" fill="none" stroke="currentcolor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2">
50 50
         <path d="M9 22 C0 23 1 12 9 13 6 2 23 2 22 10 32 7 32 23 23 22 M11 26 L16 30 21 26 M16 16 L16 30"></path>
51
-      </svg>&nbsp;&nbsp;Quick Installer
51
+      </svg>&nbsp;&nbsp;Quick Install
52 52
     {{< /hackcss-button >}}
53 53
   {{< /external >}}
54 54
   <!-- <svg viewBox="0 0 32 32" width="32" height="32" fill="none" stroke="currentcolor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2">

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

@@ -6,7 +6,7 @@ tags = ["privacy", "networking"]
6 6
 features = ["related content"]
7 7
 +++
8 8
 
9
-Unless running the [Quick Installer](../quick-installer) After Dark does not require an Internet connection to function. Leverage this feature in creative ways:
9
+Unless running the [Quick Install](../quick-install) After Dark does not require an Internet connection to function. Leverage this feature in creative ways:
10 10
 
11 11
 - Review the [Online Help](../online-help) docs during a flight on Virgin Galactic.
12 12
 - Keep a personal journal while couchsurfing through Southeast Asia.

+ 1
- 1
docs/content/feature/online-help.md View File

@@ -6,7 +6,7 @@ tags = ["scripts", "security", "networking"]
6 6
 features = ["related content"]
7 7
 +++
8 8
 
9
-Navigate to http://localhost:1414 to view the online help docs after running [Quick Installer](../quick-installer). Everything you see here is included there for [offline use](../air-gapping).
9
+Navigate to http://localhost:1414 to view the online help docs after running [Quick Install](../quick-install). Everything you see here is included there for [offline use](../air-gapping).
10 10
 
11 11
 ---
12 12
 

+ 75
- 0
docs/content/feature/quick-install.md View File

@@ -0,0 +1,75 @@
1
++++
2
+title = "Quick Install"
3
+description = "One command is all you need to start a new website."
4
+categories = ["experience"]
5
+tags = ["setup", "installation", "scripts"]
6
+features = ["code highlighter", "snippets", "related content"]
7
+notes = [
8
+  "review 'module-system' when adding or removing installed add-ons",
9
+  "also review selection of pre-installed modules (see front matter)"
10
+]
11
+aliases = [
12
+  "/feature/quick-installer/"
13
+]
14
++++
15
+
16
+After Dark source includes a portable installation script for quick set-up:
17
+
18
+<style>.card-content .inner { overflow: scroll; max-height: 30em; }</style>
19
+{{< hackcss-card header="themes/after-dark/bin/install" >}}
20
+<details>
21
+<summary>Expand to view script</summary>
22
+{{< highlight shell "linenos=inline" >}}
23
+{{< include "themes/after-dark/bin/install" >}}
24
+{{< /highlight >}}
25
+</details>
26
+{{< /hackcss-card >}}
27
+
28
+Use of the script is optional, but it will save you time.
29
+
30
+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.
31
+
32
+Run the script however you like. Here are three possible methods:
33
+
34
+2. Download and pipe to `sh` directly:
35
+
36
+    {{< hackcss-alert >}}
37
+    {{< highlight shell >}}wget -qO - https://go.habd.as/after-dark | sh{{< /highlight >}}
38
+    {{< /hackcss-alert >}}
39
+
40
+    <i>(Kahones not included.)</i>
41
+
42
+1. Download into new file, `chmod` and execute:
43
+
44
+    {{< hackcss-alert >}}
45
+    {{< highlight shell >}}curl -O cdn.jsdelivr.net/npm/after-dark@latest/bin/install && \
46
+chmod +x install && ./install{{< /highlight >}}
47
+    {{< /hackcss-alert >}}
48
+
49
+    <i>(It's safe it it comes from a CDN, ammirite?)</i>
50
+
51
+3. From canonical `git` clone:
52
+
53
+    {{< hackcss-alert >}}
54
+    {{< highlight shell >}}# clone source and change to source directory
55
+git clone https://git.habd.as/comfusion/after-dark.git && cd "$_"
56
+
57
+# use npm cli to get source integrity value
58
+echo "${$(npm run integrity)#*sha512-}"
59
+
60
+# run quick install
61
+./bin/install
62
+{{< /highlight >}}
63
+    {{< /hackcss-alert >}}
64
+
65
+    <i>(If you're really paranoid.)</i>
66
+
67
+Script should complete in 5-10 seconds resulting in a sample site and help docs:
68
+
69
+{{< figure alt="After Dark screenshots"
70
+  src="/images/quick-install.png"
71
+  lqipsrc="/images/quick-install-fs8.png"
72
+  caption="After Dark Quick Install running to completion in Terminal on macOS Mojave."
73
+>}}
74
+
75
+If you'd prefer not to run the script you can still [Download Manually](/#download) and use [Online Help](../feature/online-help) as an example to get you started.

+ 0
- 48
docs/content/feature/quick-installer.md View File

@@ -1,48 +0,0 @@
1
-+++
2
-title = "Quick Installer"
3
-description = "One command is all you need to start a new website."
4
-categories = ["experience"]
5
-tags = ["setup", "installation", "scripts"]
6
-features = ["code highlighter", "snippets", "related content"]
7
-notes = [
8
-  "review 'module-system' when adding or removing installed add-ons",
9
-  "also review selection of pre-installed modules (see front matter)"
10
-]
11
-+++
12
-
13
-After Dark source includes a portable installation script for quick set-up:
14
-
15
-<style>.card-content .inner { overflow: scroll; max-height: 30em; }</style>
16
-{{< hackcss-card header="bin/install" >}}
17
-{{< highlight shell "linenos=inline" >}}
18
-{{< include "themes/after-dark/bin/install" >}}
19
-{{< /highlight >}}
20
-{{< /hackcss-card >}}
21
-
22
-Installation 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 added dependencies.
23
-
24
-Three methods of running the script:
25
-
26
-1. Download, copy into a new file and execute it:
27
-
28
-    {{< hackcss-alert >}}
29
-    {{< highlight shell >}}wget cdn.jsdelivr.net/npm/after-dark@latest/bin/install && \
30
-chmod +x install && ./install{{< /highlight >}}
31
-    {{< /hackcss-alert >}}
32
-
33
-
34
-2. Download and pipe it to `sh` directly:
35
-
36
-    {{< hackcss-alert >}}
37
-    {{< highlight shell >}}wget -qO - https://go.habd.as/after-dark | sh{{< /highlight >}}
38
-    {{< /hackcss-alert >}}
39
-
40
-3. [Download After Dark](/#download) and execute it from a terminal with `./bin/install`.
41
-
42
-Script should complete in 5-10 seconds resulting in a sample site and help docs:
43
-
44
-{{< figure alt="After Dark screenshots"
45
-  src="/images/quick-installer.png"
46
-  lqipsrc="/images/quick-installer-fs8.png"
47
-  caption="After Dark Quick Installer running to completion in Terminal on macOS Mojave."
48
->}}

+ 1
- 1
docs/content/feature/upgrade-script.md View File

@@ -40,4 +40,4 @@ Generating help documentation ...<br>
40 40
 Upgrade complete! Please see CHANGELOG.md for changes.</samp>
41 41
 {{< /hackcss-alert >}}
42 42
 
43
-Like [Quick Installer](../quick-installer) the upgrade script is written to POSIX standard will not require additional dependencies to operate on most systems. Upon upgrade the [Release Hash](../release-hashes) will update as well so you may [Validate Release](/validate).
43
+Like [Quick Install](../quick-install) the upgrade script is written to POSIX standard will not require additional dependencies to operate on most systems. Upon upgrade the [Release Hash](../release-hashes) will update as well so you may [Validate Release](/validate).

+ 1
- 1
docs/layouts/feature/list.html View File

@@ -9,7 +9,7 @@
9 9
     {{ end }}
10 10
   </header>
11 11
   <table>
12
-    <legend>Choose a feature to learn more or run the <a href="./quick-installer">Quick Installer</a> to download and install After Dark and use the <a href="./online-help">Online Help</a> try any of these yourself:</legend>
12
+    <legend>Choose a feature to learn more or run the <a href="./quick-install">Quick Install</a> to download and install After Dark and use the <a href="./online-help">Online Help</a> try any of these yourself:</legend>
13 13
     <thead>
14 14
       <tr>
15 15
         <th scope="col">{{ .Title | singularize }}</th>

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


docs/static/images/quick-installer.png → docs/static/images/quick-install.png View File


+ 1
- 1
package.json View File

@@ -1,7 +1,7 @@
1 1
 {
2 2
   "name": "after-dark",
3 3
   "version": "6.13.3",
4
-  "description": "After Dark is an extensible flat-file CMS built on Hugo designed to create incredibly fast static websites.",
4
+  "description": "After Dark is a self-hosted flat-file CMS built on Hugo designed to create static websites ungodly fast.",
5 5
   "author": "Josh Habdas <jhabdas@protonmail.com>",
6 6
   "keywords": [
7 7
     "hugo",

Loading…
Cancel
Save