Browse Source

fix(meta): rename misspelled property

Josh Habdas 1 year ago
parent
commit
e04c0f9752
Signed by: Josh Habdas <jhabdas@protonmail.com> GPG Key ID: B148B31154C75A74
3 changed files with 14 additions and 11 deletions
  1. 1
    0
      .gitignore
  2. 12
    10
      README.md
  3. 1
    1
      layouts/partials/modules/hall-of-mirrors/meta.html

+ 1
- 0
.gitignore View File

@@ -0,0 +1 @@
1
+node_modules

+ 12
- 10
README.md View File

@@ -11,12 +11,12 @@
11 11
 
12 12
 <video controls>
13 13
   <source src="https://jhabdas.keybase.pub/after-dark-hall-of-mirrors-demo.mp4" type="video/mp4">
14
-  <p>Your browser doesn't support HTML5 video. Here is a <a href="https://jhabdas.keybase.pub/after-dark-hall-of-mirrors-demo.mp4">link to the video</a> instead. Ref: <a href="https://github.com/go-gitea/gitea/issues/3845">gitea/issues/3845</a></p>
14
+  <p>Your browser doesn't support HTML5 video. Here is a <a href="https://jhabdas.keybase.pub/after-dark-hall-of-mirrors-demo.mp4">link to the video</a> instead. Ref: <a href="https://discourse.gitea.io/t/embedding-videos-in-readmes/494">embedding-videos-in-readmes</a></p>
15 15
 </video>
16 16
 
17 17
 ## Setup
18 18
 
19
-None requried unless you're hosting your site from a subdirectory (e.g. `example.com/blog/`). If so you'll need to update the url types in `default-skin.css` to point to your base url. A script called `urlize` has been provided to facilitate this change.
19
+None required, unless you're hosting your site root from a path including a `/` such as `domain.example/blog/`. If so, update the [url data types](https://devdocs.io/css/url) in `default-skin.css` to include the full path. Use the included `bin/urlize` script to facilitate this change.
20 20
 
21 21
 ## Installation
22 22
 
@@ -34,20 +34,20 @@ None requried unless you're hosting your site from a subdirectory (e.g. `example
34 34
 
35 35
     ```toml
36 36
     [params.modules.hall_of_mirrors]
37
-      enabled = true # Required in version 0.1.0
37
+      enabled = true # Required in version 0.1.x
38 38
     ```
39 39
 
40
-4. Create a [Leaf Bundle] to group image resources you wish to display in a PhotoSwipe gallery together with your content.
41
-5. [Configure the gallery](#configuration) to your liking.
40
+4. Create a [Leaf Bundle] for your images and content.
41
+5. [Configure](#configuration) the content to reference the images.
42 42
 6. Build and deploy your After Dark site.
43 43
 
44 44
 ## Configuration
45 45
 
46
-To display a gallery add the [Page Resources] you wish to display to your [Leaf Bundle] and configure your front matter.
46
+To display a gallery add the [Page Resources] you wish to display to your [Leaf Bundle] and configure your front matter as shown.
47 47
 
48 48
 ### Minimal
49 49
 
50
-The following is all you need to display a basic gallery. Seriously.
50
+Display a gallery for all JPEG images in the page bundle:
51 51
 
52 52
 ```toml
53 53
 [[resources]]
@@ -55,6 +55,8 @@ The following is all you need to display a basic gallery. Seriously.
55 55
   name = "gallery" # Name must include the word 'gallery'
56 56
 ```
57 57
 
58
+Display a gallery for images in a specific bundle subdirectory:
59
+
58 60
 ```toml
59 61
 [[resources]]
60 62
   src = "images/gallery/**.jpg" # Restrict images to a folder
@@ -63,7 +65,7 @@ The following is all you need to display a basic gallery. Seriously.
63 65
 
64 66
 ### Extended
65 67
 
66
-If you want to add captions and enhance SEO you can configure individual resources.
68
+Add captions and enhance SEO by configuring individual resources:
67 69
 
68 70
 ```toml
69 71
 [[resources]]
@@ -96,10 +98,10 @@ If you want to add captions and enhance SEO you can configure individual resourc
96 98
   src = "images/gallery/**.jpg"
97 99
   name = "Nature gallery"
98 100
   [resources.params.meta]
99
-    genere = "digital" # Set a genere for all image resources
101
+    genre = "digital" # Set genre meta for all gallery images
100 102
 ```
101 103
 
102
-This should get you started. Expect some breaking changes as the development is completed.
104
+This should get you started. Expect some breaking changes as the development is finalized.
103 105
 
104 106
 ## License
105 107
 

+ 1
- 1
layouts/partials/modules/hall-of-mirrors/meta.html View File

@@ -3,7 +3,7 @@
3 3
 {{ range $property, $value := .Params.meta }}
4 4
   {{ if eq $property "keywords" }}
5 5
     <meta itemprop="keywords" content="{{ delimit $value ", " }}">
6
-  {{ else if in (slice "creator" "position" "genere" "material" "version" "license") $property }}
6
+  {{ else if in (slice "creator" "position" "genre" "material" "version" "license") $property }}
7 7
     <meta itemprop="{{ $property }}" content="{{ $value }}">
8 8
   {{ end }}
9 9
 {{ end }}

Loading…
Cancel
Save