Browse Source

docs(help): tackle misc updates

updates #87
pull/149/head
Josh Habdas 2 years ago
parent
commit
133c1a409a
Signed by: jhabdas GPG Key ID: B148B31154C75A74
25 changed files with 11 additions and 13 deletions
  1. +1
    -1
      docker/hugo/Dockerfile
  2. +2
    -2
      docs/content/_index.md
  3. +2
    -2
      docs/content/feature/custom-layouts.md
  4. +1
    -1
      docs/content/feature/social-meta.md
  5. +4
    -6
      docs/content/feature/telegram-iv.md
  6. +1
    -1
      docs/content/shortcode/form.md
  7. +0
    -0
      docs/static/images/instant-view-fs8.png
  8. +0
    -0
      docs/static/images/minimal-mac_1600x1200-fs8.png
  9. +0
    -0
      docs/static/images/minimal-mac_800x600-fs8.png
  10. +0
    -0
      docs/static/images/social-awareness-fs8.png
  11. +0
    -0
      docs/static/images/wtfpl.svg
  12. BIN
      images/docs/feat-installation-challenge-fs8.png
  13. BIN
      images/docs/feat-installation-challenge.png
  14. BIN
      images/docs/feat-instant-view.png
  15. BIN
      images/docs/feat-quick-installer.gif
  16. BIN
      images/docs/feat-scripted-help-server.png
  17. BIN
      images/docs/feat-scripted-upgrades.png
  18. BIN
      images/docs/feat-snippets-fs8.png
  19. BIN
      images/docs/feat-snippets.png
  20. BIN
      images/docs/feat-social-awareness.png
  21. BIN
      images/docs/feat-syntax-highlighting-fs8.png
  22. BIN
      images/docs/feat-syntax-highlighting.png
  23. BIN
      images/docs/feat-terminal-browsing-fs8.png
  24. BIN
      images/docs/feat-terminal-browsing.png
  25. +0
    -0
      images/minimal-mac.png

+ 1
- 1
docker/hugo/Dockerfile View File

@ -1,6 +1,6 @@
#
# Hugo Dockerfile for After Dark.
# View the theme at <https://themes.gohugo.io/after-dark/>.
# View the theme at <https://after-dark.habd.as/>.
#
# Copyright (C) 2018 Josh Habdas <jhabdas@protonmail.com>
#

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

@ -28,7 +28,7 @@ description = "After Dark is a complete hypermedia authoring system for the Hugo
<svg viewBox="0 0 32 32" width="32" height="32" fill="none" stroke="currentcolor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2">
<path d="M30 10 L16 26 2 10 Z" />
</svg>
{{< figure alt="After Dark screenshots" src="minimal-mac_1600x1200-fs8.png" lqipsrc="minimal-mac_800x600-fs8.png" >}}
{{< figure alt="After Dark screenshots" src="/images/minimal-mac_1600x1200-fs8.png" lqipsrc="/images/minimal-mac_800x600-fs8.png" >}}
</section>
<section>
@ -139,7 +139,7 @@ description = "After Dark is a complete hypermedia authoring system for the Hugo
<section class="grid license">
<div class="cell -12of12">
{{< external rel="noopener license" href="https://choosealicense.com/licenses/wtfpl/" >}}
<img width="48" src="wtfpl.svg">
<img width="48" src="/images/wtfpl.svg">
{{< /external >}}
</div>
</section>

+ 2
- 2
docs/content/feature/custom-layouts.md View File

@ -54,7 +54,7 @@ Resulting in the following `content` tree structure:
├── layouts
```
If already serving your site the Audiobooks section and page will immediately using the default block templates. To customize from default add a `list.html` and `single.html` to a `layouts/audiobook` directory in your site.
If already serving your site the Audiobooks section and page will appear immediately using the default block templates. To customize from default add a `list.html` and `single.html` to a `layouts/audiobook` directory in your site.
If the files don't exist yet, copy them from theme defaults:
@ -75,4 +75,4 @@ Resulting in the following `layouts` tree structure:
├── static
```
From there adjust the new `list.html` and `single.html` layouts, and leverage [Custom Styles](../custom-styles) and {{< external href="https://gohugo.io/content-management/archetypes/" text="Hugo Archetypes" />}} to achieve the desired result.
From there adjust the new `list.html` and `single.html` layouts, and leverage [Custom Styles](../custom-styles) and reference {{< external href="https://gohugo.io/templates/" text="Hugo Templates" />}} to achieve the desired result.

+ 1
- 1
docs/content/feature/social-meta.md View File

@ -8,7 +8,7 @@ features = ["code highlighter", "snippets", "related content"]
After Dark provides {{< external text="Open Graph Protocol" href="http://opengraphprotocol.org" />}} and {{< external href="https://developer.twitter.com/en/docs/tweets/optimize-with-cards" text="Twitter Cards" />}} metadata in pages to achieve rich sharing cards on Facebook, Twitter and more:
![Open Graph sharing card screenshot](data:image/png;base64,{{< include type="image" file="themes/after-dark/images/docs/feat-social-awareness-fs8.png" >}} "Example Open Graph sharing card produced by After Dark")
![Open Graph sharing card screenshot](/images/instant-view-fs8.png "Example Open Graph sharing card produced by After Dark")
Adjust `author` in {{< external href="https://gohugo.io/getting-started/configuration/" text="Site Configuration" />}} to specify name shown, if any:

+ 4
- 6
docs/content/feature/telegram-iv.md View File

@ -6,9 +6,7 @@ tags = ["author", "templating"]
features = ["related content"]
+++
Provide an {{< external href="https://instantview.telegram.org/" text="Instant View" />}} for users sharing links to your site on Telegram.
To enable instant views for After Dark create an {{< external href="https://instantview.telegram.org/my/" text="Instant View Template" />}} on the Telegram site using the following template:
After Dark provides a template guide to enable Telegram Instant Views for posts. Use it to create an {{< external href="https://instantview.telegram.org/my/" text="Instant View Template" />}} on the Telegram site:
```yaml
# enable for items in the post section
@ -26,9 +24,9 @@ image_url: $cover/self::img/@src
# author and post date extracted automatically
```
Preview your result from the Telegram site:
Preview your results on the Telegram site:
![Telegram Instant View screenshot](data:image/png;base64,{{< include type="image" file="themes/after-dark/images/docs/feat-instant-view-fs8.png" >}} "Example Telegram Instant View for After Dark")
![Telegram Instant View screenshot](/images/instant-view-fs8.png "Example Telegram Instant View for After Dark")
Additionally, if your site has a telegram channel, you can specify it by setting the following in your site config:
@ -39,4 +37,4 @@ Additionally, if your site has a telegram channel, you can specify it by setting
Specifying a channel name allows Telegram users to join your channel with a single click from within an Instant View.
See the [Telegram Instant View](https://instantview.telegram.org/docs) docs for additional help and information.
See the {{< external href="https://instantview.telegram.org/" text="Instant View on Telegram" />}} for additional information.

+ 1
- 1
docs/content/shortcode/form.md View File

@ -23,7 +23,7 @@ With auto-focused [Text Input](../text-input) requesting a new email address:
With [Text Input](../text-input) and [Label](../label) inside [Form Group](../form-group) running [Fuzzy Search](/feature/fuzzy-search) in new window:
```html
{{</* hackcss-form id="search" action="/search" target="_blank" */>}}
{{</* hackcss-form id="search" action="/search/" target="_blank" */>}}
{{</* hackcss-formgroup >}}
{{< hackcss-label for="query" text="Search query:" />}}
{{< hackcss-textinput id="query" type="search" name="s" form="search" >}}

images/docs/feat-instant-view-fs8.png → docs/static/images/instant-view-fs8.png View File


docs/static/minimal-mac_1600x1200-fs8.png → docs/static/images/minimal-mac_1600x1200-fs8.png View File


docs/static/minimal-mac_800x600-fs8.png → docs/static/images/minimal-mac_800x600-fs8.png View File


images/docs/feat-social-awareness-fs8.png → docs/static/images/social-awareness-fs8.png View File


docs/static/wtfpl.svg → docs/static/images/wtfpl.svg View File


BIN
images/docs/feat-installation-challenge-fs8.png View File

Before After
Width: 1778  |  Height: 1024  |  Size: 32 KiB

BIN
images/docs/feat-installation-challenge.png View File

Before After
Width: 1778  |  Height: 1024  |  Size: 156 KiB

BIN
images/docs/feat-instant-view.png View File

Before After
Width: 816  |  Height: 730  |  Size: 206 KiB

BIN
images/docs/feat-quick-installer.gif View File

Before After
Width: 616  |  Height: 1280  |  Size: 1.3 MiB

BIN
images/docs/feat-scripted-help-server.png View File

Before After
Width: 1078  |  Height: 250  |  Size: 30 KiB

BIN
images/docs/feat-scripted-upgrades.png View File

Before After
Width: 880  |  Height: 220  |  Size: 31 KiB

BIN
images/docs/feat-snippets-fs8.png View File

Before After
Width: 1400  |  Height: 732  |  Size: 21 KiB

BIN
images/docs/feat-snippets.png View File

Before After
Width: 1400  |  Height: 732  |  Size: 76 KiB

BIN
images/docs/feat-social-awareness.png View File

Before After
Width: 1062  |  Height: 728  |  Size: 700 KiB

BIN
images/docs/feat-syntax-highlighting-fs8.png View File

Before After
Width: 1472  |  Height: 392  |  Size: 31 KiB

BIN
images/docs/feat-syntax-highlighting.png View File

Before After
Width: 1472  |  Height: 392  |  Size: 52 KiB

BIN
images/docs/feat-terminal-browsing-fs8.png View File

Before After
Width: 1232  |  Height: 848  |  Size: 115 KiB

BIN
images/docs/feat-terminal-browsing.png View File

Before After
Width: 1232  |  Height: 848  |  Size: 584 KiB

images/docs/minimal-mac.png → images/minimal-mac.png View File


Loading…
Cancel
Save