Browse Source

docs(readme): replace screenshots in demo section with words

Josh Habdas 1 month ago
parent
commit
82c8b23af2
Signed by: Josh Habdas <jhabdas@protonmail.com> GPG Key ID: B148B31154C75A74

+ 8
- 56
README.md View File

@@ -4,7 +4,7 @@
4 4
   width="358">
5 5
 
6 6
 **Hugo Dark Theme Website Generator**
7
-<br>[Documentation](https://after-dark.habd.as) • [Releases](https://git.habd.as/comfusion/after-dark/releases) • [Community](https://t.me/afterdarkhugo)
7
+<br>[Docs](https://after-dark.habd.as) • [Releases](https://git.habd.as/comfusion/after-dark/releases) • [Community](https://t.me/afterdarkhugo)
8 8
 
9 9
 ## After Dark
10 10
 
@@ -22,6 +22,8 @@ wget -qO - https://go.habd.as/after-dark | sh
22 22
 
23 23
 ## Features
24 24
 
25
+Click a link below to learn more:
26
+
25 27
 - **[Developer Focused](https://after-dark.habd.as/#feature-workflow)**: Cross-platform, 1 dependency, single-codebase.
26 28
 - **[Incredibly Fast](https://after-dark.habd.as/#feature-speed)**: ~0.615s builds and decisecond page loads.
27 29
 - **[Privacy Aware](https://after-dark.habd.as/#feature-privacy)**: No cookies, no external requests, ephemeral hosting.
@@ -35,61 +37,11 @@ wget -qO - https://go.habd.as/after-dark | sh
35 37
 
36 38
 ## Demo
37 39
 
38
-Click a screenshot for a live demo of the functionality:
39
-
40
-<table>
41
-  <tr>
42
-    <td>
43
-      <a href="https://after-dark.habd.as/">
44
-        <img alt src="https://after-dark.habd.as/images/screenshots/after-dark-v6.15.0-homepage-fs8.png">
45
-      </a>
46
-    </td>
47
-    <td>
48
-      <a href="https://after-dark.habd.as/feature/svg-favicon/">
49
-        <img alt src="https://after-dark.habd.as/images/screenshots/feature-online-help-fs8.png">
50
-      </a>
51
-    </td>
52
-    <td>
53
-      <a href="https://after-dark.habd.as/404.html">
54
-        <img alt src="https://after-dark.habd.as/images/screenshots/feature-error-page-fs8.png">
55
-      </a>
56
-    </td>
57
-  </tr>
58
-  <tr>
59
-    <th scope="col"><center>Help Docs</center></th>
60
-    <th scope="col"><center>SVG Favicon</center></th>
61
-    <th scope="col"><center>404 Page</center></th>
62
-  </tr>
63
-</table>
64
-
65
-<table>
66
-  <tr>
67
-    <td>
68
-      <a href="https://after-dark.habd.as/module/toxic-swamp/">
69
-        <img alt src="https://after-dark.habd.as/images/screenshots/module-toxic-swamp-fs8.png">
70
-      </a>
71
-    </td>
72
-    <td>
73
-      <a href="https://after-dark.habd.as/shortcode/button/">
74
-        <img alt src="https://after-dark.habd.as/images/screenshots/shortcode-button-fs8.png">
75
-      </a>
76
-    </td>
77
-    <td>
78
-      <a href="https://after-dark.habd.as/extra/high-tea/">
79
-        <img alt src="https://after-dark.habd.as/images/screenshots/extra-high-tea-fs8.png">
80
-      </a>
81
-    </td>
82
-  </tr>
83
-  <tr>
84
-    <th scope="col"><center>Add-on Modules</center></th>
85
-    <th scope="col"><center>Form Controls</center></th>
86
-    <th scope="col"><center>IndieWeb Extras</center></th>
87
-  </tr>
88
-</table>
40
+Visit the [official docs](https://after-dark.habd.as) for demo and documentation. For an example site see [habd.as](https://habd.as). Additional examples listed in the source repository Wiki.
89 41
 
90 42
 ## Getting Started
91 43
 
92
-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).
44
+[Install Hugo](https://gohugo.io/getting-started/installing) `0.44` or greater on your machine before getting started or unless you're creating an [Extended Build](https://after-dark.habd.as/#feature-builds) or starting with [After Dark K3s](https://after-dark.habd.as/extra/after-dark-k3s).
93 45
 
94 46
 ### Installation
95 47
 
@@ -112,11 +64,11 @@ flying-toasters
112 64
 
113 65
 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.
114 66
 
115
-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.
67
+After Dark releases are tagged in git and [packaged on NPM](https://www.npmjs.com/package/after-dark). Use the NPM package to integrate After Dark into existing workflows.
116 68
 
117 69
 ### Usage
118 70
 
119
-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.
71
+Review the [Online Help](https://after-dark.habd.as/feature/online-help/) to learn how to set-up and customize After Dark. Docs included with installation and may be served locally.
120 72
 
121 73
 ### Upgrading
122 74
 
@@ -126,7 +78,7 @@ Run the [Upgrade Script](https://after-dark.habd.as/feature/upgrade-script/) to
126 78
 ./themes/after-dark/bin/upgrade
127 79
 ```
128 80
 
129
-Upgrading replaces the file contents of the theme as a whole.
81
+Upgrading replaces the file contents of the theme as a whole for security reasons. If you wish to modify the source please create a fork.
130 82
 
131 83
 ### Verifying
132 84
 

BIN
docs/static/images/screenshots/extra-high-tea-fs8.png View File


BIN
docs/static/images/screenshots/feature-error-page-fs8.png View File


BIN
docs/static/images/screenshots/feature-online-help-fs8.png View File


BIN
docs/static/images/screenshots/module-toxic-swamp-fs8.png View File


BIN
docs/static/images/screenshots/shortcode-button-fs8.png View File


Loading…
Cancel
Save