Skip to content

Latest commit

 

History

History
111 lines (69 loc) · 3.7 KB

README.md

File metadata and controls

111 lines (69 loc) · 3.7 KB
Raw

Newsroom Theme

This is a simple, minimalistic theme, which is inspired by Apple's Newsroom page. It uses grid css, flexbox & js (no jQuery, or related libraries).

Hugo Newsroom Theme

Features

  • Blog
  • Modern
  • Responsive
  • Deeplinks
  • Dark Mode
  • Supports native lazy loading of images
  • Syntax highlighting

Deeplinks

For all content published using markdown, deeplinks will be added to the pages so that you can share with precision 😃 Just hover on a heading and the link button will pop. Click it to copy.

Installation

Add this theme as a Git submodule inside your Hugo site folder:

git submodule add https://github.com/onweru/newsroom.git themes/newsroom

Theme hugo sass and hugo-extended version.

Configuration

You can configure the site as follows:

  1. General Information

    Use config.toml file.

  2. menu, footer

    See the yaml files inside the data/ directory.

Start publishing

Follow the exampleSite/; specifically, the content directory

Dark Mode

Today, operating systems have a system-wide light ~ dark mode switch. Your website will adapt to the user's preferred lighting mode. Still, if the user wants to opt in or out of darkmode, there's a UI control for that too in the menu 😊.

Dark Mode

Custom 404 Page

Normal Mode Dark Mode
404 page 404 page on dark Mode

Syntax highlighting

Normal Mode Dark Mode
404 page 404 page on dark Mode

If you wish, you can opt to use Chroma.

I want to use disqus

If you like, you could use disqus on your site. To enable disqus on your site, simply, add the line below to you config.toml file. If you're working off the exampleSite, the line is already there; just uncomment it.

disqusShortname = "yourdiscussshortname"

Remember to edit the yourdiscussshortname appropriately.

From your disqus dashboard, set your scripts color scheme to auto. See screenshot below

Custom Shortcodes

This theme ships with 2 custom shortcodes (they both use positional parameters):

  1. Video This shortcode can be used to embed a youtube video with custom styling. It takes a solo positional parameter.

    ...
{{< video "youtubeVideoID" >}}
...

  2. Picture You want to use darkmode images when darkmode is enabled on a device and a regular image on lightmode? It takes 3 positional parameter

    Store these images in the static/images directory.

    ...
{{< picture "lightModeImage.png" "darkModeImage.png" "Image alt text" >}}
...

From the same creator

  1. Swift Theme
  2. Compose Theme

License

This theme is available under the MIT license.