Browse Source

fix(meta): rename misspelled property

master
Josh Habdas 2 years ago
parent
commit
e04c0f9752
Signed by: jhabdas 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 @@
node_modules

+ 12
- 10
README.md View File

@ -11,12 +11,12 @@
<video controls>
<source src="https://jhabdas.keybase.pub/after-dark-hall-of-mirrors-demo.mp4" type="video/mp4">
<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>
<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>
</video>
## Setup
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.
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.
## Installation
@ -34,20 +34,20 @@ None requried unless you're hosting your site from a subdirectory (e.g. `example
```toml
[params.modules.hall_of_mirrors]
enabled = true # Required in version 0.1.0
enabled = true # Required in version 0.1.x
```
4. Create a [Leaf Bundle] to group image resources you wish to display in a PhotoSwipe gallery together with your content.
5. [Configure the gallery](#configuration) to your liking.
4. Create a [Leaf Bundle] for your images and content.
5. [Configure](#configuration) the content to reference the images.
6. Build and deploy your After Dark site.
## Configuration
To display a gallery add the [Page Resources] you wish to display to your [Leaf Bundle] and configure your front matter.
To display a gallery add the [Page Resources] you wish to display to your [Leaf Bundle] and configure your front matter as shown.
### Minimal
The following is all you need to display a basic gallery. Seriously.
Display a gallery for all JPEG images in the page bundle:
```toml
[[resources]]
@ -55,6 +55,8 @@ The following is all you need to display a basic gallery. Seriously.
name = "gallery" # Name must include the word 'gallery'
```
Display a gallery for images in a specific bundle subdirectory:
```toml
[[resources]]
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.
### Extended
If you want to add captions and enhance SEO you can configure individual resources.
Add captions and enhance SEO by configuring individual resources:
```toml
[[resources]]
@ -96,10 +98,10 @@ If you want to add captions and enhance SEO you can configure individual resourc
src = "images/gallery/**.jpg"
name = "Nature gallery"
[resources.params.meta]
genere = "digital" # Set a genere for all image resources
genre = "digital" # Set genre meta for all gallery images
```
This should get you started. Expect some breaking changes as the development is completed.
This should get you started. Expect some breaking changes as the development is finalized.
## License

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

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

Loading…
Cancel
Save