Skip to content

Commit

Permalink
Fixing typos, minor improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
deining committed Feb 23, 2022
1 parent 39511a6 commit 8eac44e
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 8 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
@@ -1,6 +1,6 @@
# Contributing to reveal-hugo

Contributions of all shapes and sizes are welcoming, including code, documentation, and examples. If you've built something with reveal-hugo, feel free to add it to the README.
Contributions of all shapes and sizes are welcome, including code, documentation, and examples. If you've built something with reveal-hugo, feel free to add it to the README.

To run the example site, clone this repository and run:

Expand All @@ -20,7 +20,7 @@ You can also build the site without watching it for changes by running:
npm run build
```

GitHub issues and PRs are the preferred way to receive contributions. Please name your branch something recognizeable.
GitHub issues and PRs are the preferred way to receive contributions. Please name your branch something recognizable.

Before opening a PR, make sure that the reveal-hugo exampleSite builds. The demo presentations in exampleSite use nearly all of the available reveal-hugo functionality, so they're a good indicator of something that might have been broken. Still, there are no fully automated tests, so please make sure to manually test areas that could be impacted by your change.

Expand Down
4 changes: 2 additions & 2 deletions README.md
Expand Up @@ -404,7 +404,7 @@ Syntax highlighting can be done with Hugo at compile-time or using Reveal.js wit

To do highlighting with Hugo, use the [highlight shortcode](https://gohugo.io/content-management/syntax-highlighting/#highlight-shortcode) and check out the [hugo-hl-example](https://reveal-hugo.dzello.com/hugo-hl-example/) example presentation.

To see an example of highlighting with Reveal.js, checs out the [highlightjs-linenumbers-example](https://reveal-hugo.dzello.com/highlightjs-linenumbers-example/) presentation.
To see an example of highlighting with Reveal.js, check out the [highlightjs-linenumbers-example](https://reveal-hugo.dzello.com/highlightjs-linenumbers-example/) presentation.

By default, markdown code fences will be processed with Hugo. To turn that off, add this to your `config.toml` file:

Expand Down Expand Up @@ -535,7 +535,7 @@ Now you can add `outputs = ["Reveal"]` to the front matter of any section's `_in

Note: If you specify `outputs = ["Reveal"]` for a single content file, you can prevent anything being generated for that file. This is handy if you other default layouts that would have created a regular HTML file from it. Only the list file is required for the presentation.

**Tip**: As of Hugo 0.42, Hugo [has theme inheritence](https://gohugo.io/news/0.42-relnotes/). You can avoid the file copying step above by adding `"reveal-hugo"` to your site's array of themes.
**Tip**: As of Hugo 0.42, Hugo [has theme inheritance](https://gohugo.io/news/0.42-relnotes/). You can avoid the file copying step above by adding `"reveal-hugo"` to your site's array of themes.

### Create a presentation from a leaf bundle or single page type

Expand Down
1 change: 1 addition & 0 deletions exampleSite/.gitignore
@@ -0,0 +1 @@
.hugo_build.lock
4 changes: 2 additions & 2 deletions exampleSite/content/logo-example/_index.md
Expand Up @@ -51,9 +51,9 @@ top = "1%" # Overrides diag.
right = "1%" # Overrides diag.
```

- Instead of absolute (`250px`), relative measurments (`12.5%`) should be used. They work better with different screen sizes.
- Instead of absolute (`250px`), relative measurements (`12.5%`) should be used. They work better with different screen sizes.

- By default, null (`""`) is used as alt text for logos, as otherwise the alt text would unneededly get read by screen readers.
- By default, null (`""`) is used as alt text for logos, as otherwise the alt text would unnecessarily get read by screen readers.

---

Expand Down
4 changes: 2 additions & 2 deletions netlify.toml
Expand Up @@ -3,7 +3,7 @@ command = "hugo -b $URL -s exampleSite"
publish = "exampleSite/public"

[context.production.environment]
HUGO_VERSION = "0.65.3"
HUGO_VERSION = "0.92.2"

[context.deploy-preview.environment]
HUGO_VERSION = "0.65.3"
HUGO_VERSION = "0.92.2"

0 comments on commit 8eac44e

Please sign in to comment.