https://github.com/elnudev/sakura-hugo-theme

A minimal blog theme for Hugo using Sakura.
https://github.com/elnudev/sakura-hugo-theme

hugo hugo-blog hugo-blog-theme hugo-theme

Last synced: 14 days ago
JSON representation

A minimal blog theme for Hugo using Sakura.

• Host: GitHub
• URL: https://github.com/elnudev/sakura-hugo-theme
• Owner: ElnuDev
• License: gpl-3.0
• Created: 2022-06-09T00:38:28.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-07-23T01:45:33.000Z (over 2 years ago)
• Last Synced: 2024-11-01T00:40:45.438Z (2 months ago)
• Topics: hugo, hugo-blog, hugo-blog-theme, hugo-theme
• Language: HTML
• Homepage:
• Size: 206 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# sakura-hugo-theme

A minimal blog theme for Hugo using [Sakura](https://github.com/oxalorg/sakura) that uses no custom CSS. Supports furigana/ruby text `[振]{ふ}り[仮]{が}[名]{な}` markup out of the box.

For an example of this theme in action, check out [my blog](https://blog.elnu.com/) ([repository](https://github.com/ElnuDev/blog.elnu.com))!

If you're using Hugo's syntax highlighting and one of the light Sakura variants, it's recommended to use the `friendly` theme. To use it, add the following to your `config.toml`:

```TOML

[markup]

	[markup.highlight]

		style = 'friendly'

```

## Parameters

This theme supports some basic configuration options in addition to support for [Matomo analytics](https://matomo.org/), a FOSS and self-hosted analytics solution.

- `Author`: Author name for all posts. Required for proper post metadata.

- `AuthorProfile`: URL to author profile, used for [Open Graph](https://ogp.me/).

- `AuthorTwitter`: Author Twitter handle **without @**, used for Twitter cards.

- `SiteTwitter`: Site Twitter handle (generally should be same as `AuthorTwitter`)

- `Theme`: Variant of Sakura to use. If unspecified, will default to `sakura.css`. e.g `Theme = 'dark'` will use `sakura-dark.css`. Available variant themes:

  - `dark-solarized`

  - `dark`

  - `earthly`

  - `ink`

  - `pink`

  - `vader`

- `ThemeColor`: Theme color for embeds, etc. eg. `#000000`

- `HomepageHeader`: Text displayed at the absolute top of the homepage, hidden on pagination. Can include HTML markup.

- `MatomoURL`: URL of Matomo analytics server.

- `MatomoSiteId`: Site ID of Matomo. **Must be string.**