Skip to content

Latest commit

 

History

History
133 lines (89 loc) · 3.73 KB

README.md

File metadata and controls

133 lines (89 loc) · 3.73 KB
Raw

Chunky poster

CircleCI

A simple, bootstrap 4 based blog theme. The structure and design is based on the Prisma blog.

Demo | Demo 2

Screenshot

Chunky poster

Features

  • Multi-author
  • Image processing
  • Basic i18n
  • Prism
  • LazyLoad
  • Commento
  • Image gallery

Usage

git clone https://github.com/puresyntax71/hugo-theme-chunky-poster.git

Check out the configuration at exampleSite/config.toml for configuring your Hugo site.

Authors

The authors structure is based on this blog post.

  1. Add the taxonomy "author".

  2. hugo new authors/john-doe/_index.md

  3. Configure the author metadata twitter.

  4. Configure the author metadata images. First image on the list will be used as the avatar and on the profile page. Images are page resources under the author e.g. content/authors/john-doe/image.png.

  5. Assign the author to a content:

    ---
authors: ["John Doe"]
---

Content images

The images structure is based on this blog post.

Upload the images that will be used on content pages under content/images and create the file content/images/index.md with the front matter:

---
headless: true
---

Set the path to the image in a post content under the images property:

---
images: ["/images/image.png"]
---

The first image on the list will be used as the "cover" image on a post.

Prism

Configure Prism under [params.prismJS] and set enable to true. Change the theme under theme.

[params]
  [params.prismJS]
    enable = true
    theme = "okaidia"

Commento

Configure Commento under [params.commento]. Set enable to true and add the URL at url:

[params]
  [params.commento]
    enable = true
    url = "https://somename.commento.io"

Share

Enable sharing under params with share set to true and disable per-post sharing by setting share to false in the front matter.

[params]
  share = true
---
share: false
---

Image gallery

The image gallery feature uses the ekko-lightbox and figure shortcode. This is just a simple implementation of the lightbox gallery feature from the library.

Customization

Fork the project and run yarn watch during development.

The project has an .nvmrc if you wish to use nvm.

The application javascript file is located at src/js/app.js.

For customizing SCSS, the main entrypoint is at src/scss/style.scss. Bootstrap variables can be overridden in the _variables.scss file. The theme's styles are located at src/scss/chunky-poster.scss.

For production, you can run yarn build for the assets to be updated.

Credits

Images from Unsplash and Freepik.

License

This theme is released under the MIT license.