Skip to content

Latest commit

 

History

History
173 lines (136 loc) · 8.38 KB

README.md

File metadata and controls

173 lines (136 loc) · 8.38 KB
Raw

Eclectic

A theme for high performance customizable hugo websites.

Eclectic Theme

NOTE: REQUIRES ATTRIBUTION IN FOOTER TO STAY INTACT FOR USAGE.

See atishay.me for sample website.

Key Features:

  • Fast
  • Millions of color themes with CSS Variables
  • Color switcher to allow users to customize the color theme.
  • Dark mode support.
  • Structured metadata support for adding advanced content to any page (not just home page).
  • Configurable footer.
  • Search support (no external dependencies).
  • Full SEO with JSON-LD, twitter cards and open graph.
  • CSS Grid based powerful grid system.

Layout Types

  • default Pages with simple markdown content. Support structured metadata described below.
  • post Used for pages where the content has a sidebar, a cover image etc.
  • contact Used for Contact Us pages.

Images

  • assets/image/favicon.svg - Favicon SVG Version
  • assets/image/favicon.png - Favicon PNG Version
  • assets/image/logo.svg or assets/image/logo.png - Logo

Search

  • The theme creates a JSON of the entire website in the home pages's index.json which is used for search.
  • To get the search functionality, add the json output format to the home page.
[outputs]
  home = [
   "html",
   "rss",
   "json"
  ]

Series

If series taxonomy is used, pages from the same series are shown in the related pages before using any other related pages.

Menus

  • main - Top menu shown in the header. Supports one nested level of submenus. Uses the Section name to find the appropriate top level item to highlight.
  • footer The footer menu (does not have submenu support).

Template blocks

  • favicon - Present in the <head> tag. Defaults to basic favicon and basic apple touch icon support.
  • social - All the data for open graph, twitter cards and JSON-LD. Contains sub-blocks
    • opengraph - For Open Graph tags
    • meta - General meta tags like description and canonical url.
    • jsonld - JSON-LD for Google.

Footer

  • The footer contains up to sections that can be specified in the front matter. The template has special column arrangement for the sectioning as defined below.

  • There can be modified in the settings as an array in Site.Params.Footer with the following options

    • title - Title of the section.
    • content - In Markdown
    • image - Show an image in the section (by default pulled to the left with 50% width).
    • recent - Name of the section to show recents from.
    • recentCount - Count for the recent range.
    • contact - Optimized version of the contact us snippets. The order and contents are not customizable as you can still use markdown to make a custom version.
    • menu - Displays the menu named footer. Does not have sub-menu support.

Column arrangements

CSS Grids are used for column arrangements in the most logical manner.

  • 1 - Single Item
  • 2 - Two items till md
  • 3 - Three items till lg
  • 4 - 4 items till xl, 2 2 till md
  • 5 - 2 3 till lg, 2 2 1 till md
  • 6 - 3 3 till lg, 2 2 2 till md
  • 7 - 3 4 till xl, 3 3 1 till lg, 2 2 2 1 till md
  • 8 - 4 4 till xl, 2 2 2 2 till md
  • 9 - 3 3 3 till lg
  • 12 - 4 4 4 till xl, 3 3 3 3 till lg, 2 2 2 2 2 2 till md

8 and 9 can be further improved if needed.

Settings

  • Site.Params.colorPickerEnabled Enable color picker to help the user switch color themes as well as dark mode.
  • Site.Params.checksDarkMode - Should enable automatic switching to dark mode based on media query.
  • Site.Params.custom_css - Custom CSS File for overrides.
  • Site.Params.github - Github link for the octocat on top right.
  • Site.Params.custom_css - Custom CSS Overrides file.
  • Site.Author - Contains facebook, twitter, github, email, linkedin and name fields.
  • Site.Params.color - Default theme color.
  • Site.Params.description - Default Description.
  • Site.Params.sidebar - Shared sidebar for all posts. Will be available under the post specific sidebar.
  • Site.Params.sharedHeader - List of sections where the header has no changes (like blogs unless we have a submenu). This cached headers to improve performance.
  • Site.Params.Guitar - guitar2svg hosted location.
  • Site.Params.scss - Set this to true if using Hugo extended - the scss version is pre-compiled as main.css to support non-extended Hugo version. This is to allow new developers on Hugo to non get stuck with the extended requirement. Enable if looking for CSS bugs.

Browsers

  • This theme uses all modern CSS like CSS Variables, CSS Grid and Flexbox. Do not expect this to support older browsers.

Posts

  • Use Hugo Page Bundles for posts. The theme automatically picks up cover.jpg in the page bundle as the cover image.

Top Matter

  • sidebar - You can add stuff to the page sidebar by using a the front matter and passing a list to sidebar with title and content properties. content can be markdown.
  • coverAnchor - Add anchoring position for the cover image.

Shortcodes

  • fig Same as figure, but added support for providing image size.
  • guitar Renders guitar tabs and chords using jtab. Needs Site.Params.Guitar for the guitar2svg hosting.

Structured metadata

You can supplied structured metadata in a default page. These pages provide multiple sections with advanced styling and grouping into columns, support for carousels, lists etc. In the front matter, you can supply the following information a list in the content to render structured data:

  • file Reads the structured data from a file instead of from inline properties. The file can be present in the page bundle for the page or the asset bundle for the entire website. It is recommended to use separate files if the data gets large.
  • title The title of the section
  • subtitle Section's subtitle
  • image Top level image for the section:
    • href relative location fo the image inside assets folder.
    • alt Alt text to the image
    • width Desired width
    • height Desired height
  • content Markdown content
  • icon Section icon (Can be a file relative to assets or a fontawesome name eg link for fa-link)
  • items List of items to display in the section. Each item contains the following:
    • title Item's title
    • content Markdown content of the item
    • image Image for the item. Contains the following:
      • href relative location
      • width desired width
      • height desired height
      • alt Alt text to the image
      • anchor Anchor location for resizing the image
    • attribution Markdown content for image attribution.
    • icon Contains the item's icon. Consists of:
      • href relative location
      • alt Alt text
      • width Element width
      • height Element height
  • type Section type. Can be one fo the following:
    • Unspecified content grouped into columns as described in column arrangement.
    • left-image Full sized image floated to the left.
    • item-icon-left Icon is shown to the left of the item in the grid
    • full-width Each item takes full width instead of being placed in the grid.
    • max-2 Alternate grid with maximum items specified each row to be 2.
    • filter Provides a filter list. The top level has additional parameter called filter for the default filter. Each item has a a space separated list of filters in a field called filter applicable to the item.
    • blog to show recent blog entries. Has additional parameters count which is the number of blog items and section which is the name of the section to get recent posts from.
    • carousel Provides support for running a carousel of content.
    • centered Provides content centered on the page behind the background image supplied as background
    • content Renders the content of the page's markdown content outside of the params. If not provided, page's markdown is rendered at the bottom and honors the page's title and subtitle properties.

NOTE: Almost all the properties are optional. The theme is usable without providing any of the config properties.

Credits

Ecelectic is a collection of some of the best work in Hugo. It incorporates many of great components that the Hugo community provides. Here are some of them: