Skip to content

README.md

Latest commit

 

History

History
79 lines (54 loc) · 2.36 KB

README.md

File metadata and controls

79 lines (54 loc) · 2.36 KB
Raw

Hugo Blueprint

Hugo Blueprint is Zixiang Zhang's personal design language for Hugo, originated from his personal website. It is a PaperMod-derived theme for dense technical blogs, project logs, and research notes.

Author: Zixiang Zhang. Personal Hugo blog: kircerta.com.

Preview

Blueprint dark preview

Blueprint light preview

Theme Surface

  • Article-card home and list pages with compact metadata.
  • Blueprint dark and light visual modes with a fixed mode switch.
  • Collapsible table of contents support for long technical posts.
  • Styled archives, search, tags, pagination, tables, and code blocks.
  • Multilingual example site and theme labels under params.blueprint.

Install

Add the theme to a Hugo site:

git submodule add https://github.com/Kircerta/hugo-blueprint.git themes/hugo-blueprint

Set the theme:

theme = "hugo-blueprint"

Configuration

baseURL = "https://example.com/"
title = "Blueprint"
theme = "hugo-blueprint"
defaultTheme = "dark"
disableThemeToggle = true
enableRobotsTXT = true

[outputs]
  home = ["HTML", "RSS", "JSON"]

[params]
  mainSections = ["posts"]
  ShowReadingTime = true
  ShowToc = true
  TocOpen = false

  [params.blueprint]
    homeKicker = "BLUEPRINT BLOG"
    articlePrefix = "ARTICLE"
    entryCta = "READ ARTICLE"
    documentLabel = "ARTICLE"
    darkLabel = "BLUEPRINT DARK"
    lightLabel = "BLUEPRINT LIGHT"

Example Site

Demo: https://kircerta.github.io/hugo-blueprint/

Build the included example site:

hugo --source exampleSite --themesDir ../.. --theme hugo-blueprint --destination /tmp/hugo-blueprint-example --cleanDestinationDir --gc --minify

Attribution

Blueprint is derived from hugo-PaperMod by Aditya Telange. Thanks to Hugo and the Hugo authors. PaperMod and Blueprint are distributed under the MIT License.

License

MIT. See LICENSE.